{"_id":"5632a5e949e16d0d00122480","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":"","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,"user":"55b932ba8fd1a02b00f496c8","project":"55b933b3146ef121002158d3","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:09:58.668Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Retrieve the status of a currently running batch.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method allows you to retrieve the status of a currently running batch.\nThis method is useful in determining whether a batch has been submitted to the gateway for processing, has been paused or is waiting to be uploaded.\nTo retrieve the status of batches other than the currently running batch, use the [getBatchStatus](/docs/getbatchstatus) method.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nBatchUploadStatus **getBatchUploadStatus** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer UploadRefNum )\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Arguments\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"[ueSecurityToken](/docs/uesecuritytoken)\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and validate transaction.\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"UploadRefNum\",\n    \"1-2\": \"A unique upload reference number assigned by the gateway.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Value\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"Returns the status of the currently running batch. Possible results include: open, closing, closed.\",\n    \"0-0\": \"[BatchUploadStatus](/docs/batchuploadstatus)\"\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->getBatchUploadStatus($sourcekey,$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 eBizCharge.BatchUploadStatus = New eBizCharge.BatchUploadStatus\\n       res = client.getBatchUploadStatus(token, uploadrefnum)\\n       MsgBox(res.Status)\",\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           eBizCharge.BatchUploadStatus res = new eBizCharge.BatchUploadStatus();\\n           try\\n           {\\n               res = client.getBatchUploadStatus(token, uploadrefnum);\\n               MessageBox.Show(string.Concat(res.Status));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\nxmlns:ns1=\\\"urn:eBizCharge\\\" xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\nxmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\nxmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\nSOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:getBatchUploadStatus>\\n<Token xsi:type=\\\"ns1:ueSecurityToken\\\">\\n<ClientIP xsi:type=\\\"xsd:string\\\">192.168.0.1</ClientIP>\\n<PinHash xsi:type=\\\"ns1:ueHash\\\">\\n<HashValue xsi:type=\\\"xsd:string\\\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\\n<Seed xsi:type=\\\"xsd:string\\\">12678150211876663375</Seed>\\n<Type xsi:type=\\\"xsd:string\\\">sha1</Type>\\n</PinHash>\\n<SourceKey xsi:type=\\\"xsd:string\\\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\\n</Token>\\n<UploadRefNum xsi:type=\\\"xsd:integer\\\">288</UploadRefNum>\\n</ns1:getBatchUploadStatus>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getbatchuploadstatus","type":"basic","title":"getBatchUploadStatus"}

getBatchUploadStatus


Retrieve the status of a currently running batch. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method allows you to retrieve the status of a currently running batch. This method is useful in determining whether a batch has been submitted to the gateway for processing, has been paused or is waiting to be uploaded. To retrieve the status of batches other than the currently running batch, use the [getBatchStatus](/docs/getbatchstatus) method. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] BatchUploadStatus **getBatchUploadStatus** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer UploadRefNum ) [block:api-header] { "type": "basic", "title": "Arguments" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "[ueSecurityToken](/docs/uesecuritytoken)", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and validate transaction.", "1-0": "integer", "1-1": "UploadRefNum", "1-2": "A unique upload reference number assigned by the gateway." }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-1": "Returns the status of the currently running batch. Possible results include: open, closing, closed.", "0-0": "[BatchUploadStatus](/docs/batchuploadstatus)" }, "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->getBatchUploadStatus($sourcekey,$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 eBizCharge.BatchUploadStatus = New eBizCharge.BatchUploadStatus\n res = client.getBatchUploadStatus(token, uploadrefnum)\n MsgBox(res.Status)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string uploadrefnum = \"1137\";\n eBizCharge.BatchUploadStatus res = new eBizCharge.BatchUploadStatus();\n try\n {\n res = client.getBatchUploadStatus(token, uploadrefnum);\n MessageBox.Show(string.Concat(res.Status));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\nxmlns:ns1=\"urn:eBizCharge\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\nxmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\nxmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\nSOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:getBatchUploadStatus>\n<Token xsi:type=\"ns1:ueSecurityToken\">\n<ClientIP xsi:type=\"xsd:string\">192.168.0.1</ClientIP>\n<PinHash xsi:type=\"ns1:ueHash\">\n<HashValue xsi:type=\"xsd:string\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\n<Seed xsi:type=\"xsd:string\">12678150211876663375</Seed>\n<Type xsi:type=\"xsd:string\">sha1</Type>\n</PinHash>\n<SourceKey xsi:type=\"xsd:string\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\n</Token>\n<UploadRefNum xsi:type=\"xsd:integer\">288</UploadRefNum>\n</ns1:getBatchUploadStatus>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]