{"_id":"5632a5e849e16d0d0012247a","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,"project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","category":{"_id":"5632a5e749e16d0d00122448","version":"5632a5e549e16d0d00122443","__v":1,"pages":["5632a5e849e16d0d00122478","5632a5e849e16d0d00122479","5632a5e849e16d0d0012247a","5632a5e849e16d0d0012247b","5632a5e849e16d0d0012247c"],"project":"55b933b3146ef121002158d3","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-03T18:10:18.431Z","from_sync":false,"order":6,"slug":"credit-card-batches","title":"Credit Card Batches"},"githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:11:08.617Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Retrieves the status of a batch specified by its BatchRefNum.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method will check on the status of any batch within the merchant console. Enter the BatchRefNum (a unique batch reference number assigned by the gateway) into the search field and the method will return the status of the requested batch.\nTo pull the status of the currently open batch (which has not yet passed to the gateway), use 0 for the the BatchRefNum.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nBatchStatus **getBatchStatus** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer BatchRefNum )\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\": \"BatchRefNum\",\n    \"1-2\": \"A unique batch 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\": \"This method returns a BatchStatus object which includes information about the requested batch including BatchRefNum (if assigned), batch sequence, status (open, closing, or closed) dates and times when the batch was opened and closed, sales count, credit count, total settled amount and other pertinent details.\",\n    \"0-0\": \"[BatchStatus](/docs/batchstatus)\"\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 $BatchRefNum=0;\\n $Result=$client->getBatchStatus($token, $BatchRefNum);  \\n}\\ncatch (SoapFault $e) {\\n echo \\\"get Batch Upload status failed :\\\" .$e->getMessage();\\n}\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Java \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"try {\\n //Set BatchNum to the Batch Reference Number of the batch\\n //you want to retrieve.  0 is always the current batch\\n BigInteger BatchNum = new BigInteger(\\\"0\\\");\\n BatchStatus batchstat = new BatchStatus();\\n batchstat = client.getBatchStatus(token, BigInteger.ZERO);\\n} catch (Exception e) {\\n   System.out.println(\\\"Soap Exception: \\\" + e.getMessage());\\n}\",\n      \"language\": \"java\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim BatchRefNum As String\\n       BatchRefNum = \\\"9581\\\"\\n       Dim result as eBizCharge.BatchStatus = New eBizCharge.BatchStatus\\n       result = client.getBatchStatus(token, BatchRefNum)\\n       MsgBox(result.Status)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string BatchRefNum;\\n           BatchRefNum = \\\"9581\\\";\\n           eBizCharge.BatchStatus result = new eBizCharge.BatchStatus();\\n           try\\n           {\\n               result = client.getBatchStatus(token, BatchRefNum);\\n               MessageBox.Show(string.Concat(result.Status));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\\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:getBatchStatus>\\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<BatchRefNum xsi:type=\\\"xsd:integer\\\">0</BatchRefNum>\\n</ns1:getBatchStatus>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getbatchstatus","type":"basic","title":"getBatchStatus"}
Retrieves the status of a batch specified by its BatchRefNum. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method will check on the status of any batch within the merchant console. Enter the BatchRefNum (a unique batch reference number assigned by the gateway) into the search field and the method will return the status of the requested batch. To pull the status of the currently open batch (which has not yet passed to the gateway), use 0 for the the BatchRefNum. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] BatchStatus **getBatchStatus** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer BatchRefNum ) [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": "BatchRefNum", "1-2": "A unique batch 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": "This method returns a BatchStatus object which includes information about the requested batch including BatchRefNum (if assigned), batch sequence, status (open, closing, or closed) dates and times when the batch was opened and closed, sales count, credit count, total settled amount and other pertinent details.", "0-0": "[BatchStatus](/docs/batchstatus)" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $BatchRefNum=0;\n $Result=$client->getBatchStatus($token, $BatchRefNum); \n}\ncatch (SoapFault $e) {\n echo \"get Batch Upload status failed :\" .$e->getMessage();\n}\n?>", "language": "php" } ] } [/block] ## Java [block:code] { "codes": [ { "code": "try {\n //Set BatchNum to the Batch Reference Number of the batch\n //you want to retrieve. 0 is always the current batch\n BigInteger BatchNum = new BigInteger(\"0\");\n BatchStatus batchstat = new BatchStatus();\n batchstat = client.getBatchStatus(token, BigInteger.ZERO);\n} catch (Exception e) {\n System.out.println(\"Soap Exception: \" + e.getMessage());\n}", "language": "java" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim BatchRefNum As String\n BatchRefNum = \"9581\"\n Dim result as eBizCharge.BatchStatus = New eBizCharge.BatchStatus\n result = client.getBatchStatus(token, BatchRefNum)\n MsgBox(result.Status)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string BatchRefNum;\n BatchRefNum = \"9581\";\n eBizCharge.BatchStatus result = new eBizCharge.BatchStatus();\n try\n {\n result = client.getBatchStatus(token, BatchRefNum);\n MessageBox.Show(string.Concat(result.Status));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }\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:getBatchStatus>\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<BatchRefNum xsi:type=\"xsd:integer\">0</BatchRefNum>\n</ns1:getBatchStatus>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]