{"_id":"5632a5ea49e16d0d00122485","user":"55b932ba8fd1a02b00f496c8","__v":0,"githubsync":"","category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"project":"55b933b3146ef121002158d3","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"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:51:12.717Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"Contains information about a batch awaiting settlement.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object contains information about a batch of transactions that has been authorized and is awaiting settlement. It is returned when attempting to determine the status of a batch using the [getBatchStatus](/docs/getbatchstatus) method.\nThis should reflect the same information contained in the Batch Manager section of the merchant console.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\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\": \"Integer\",\n    \"0-1\": \"BatchRefNum\",\n    \"0-2\": \"Batch reference number (assigned by the gateway).\",\n    \"1-0\": \"Integer\",\n    \"1-1\": \"Sequence\",\n    \"1-2\": \"Batch sequence number\",\n    \"2-0\": \"String\",\n    \"2-1\": \"Status\",\n    \"2-2\": \"Status of this batch (ie: open, closing, closed)\",\n    \"3-0\": \"String\",\n    \"3-1\": \"Opened\",\n    \"3-2\": \"Date/time the batch was opened (first transaction was run)\",\n    \"4-0\": \"String\",\n    \"4-1\": \"Closed\",\n    \"4-2\": \"Date/time the batch was closed (if it has been closed)\",\n    \"5-0\": \"String\",\n    \"5-1\": \"Scheduled\",\n    \"5-2\": \"Date/time the batch is scheduled to close\",\n    \"6-0\": \"Integer\",\n    \"6-1\": \"TransactionCount\",\n    \"6-2\": \"Number of transactions in the batch\",\n    \"7-0\": \"Integer\",\n    \"7-1\": \"SalesCount\",\n    \"7-2\": \"Number of sales in the batch\",\n    \"8-0\": \"Integer\",\n    \"8-1\": \"CreditsCount\",\n    \"8-2\": \"Number of credits in the batch\",\n    \"9-0\": \"Integer\",\n    \"9-1\": \"VoidsCount\",\n    \"9-2\": \"Number of voids in the batch\",\n    \"10-0\": \"Double\",\n    \"10-1\": \"SalesAmount\",\n    \"10-2\": \"Dollar amount of the sales\",\n    \"11-0\": \"Double\",\n    \"11-1\": \"CreditsAmount\",\n    \"11-2\": \"Dollar amount of the credits\",\n    \"12-0\": \"Double\",\n    \"12-1\": \"NetAmount\",\n    \"12-2\": \"Dollar amount of the sales-credits\",\n    \"13-0\": \"Double\",\n    \"13-1\": \"VoidsAmount\",\n    \"13-2\": \"Dollar amount of the voids\"\n  },\n  \"cols\": 3,\n  \"rows\": 14\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\\n// for directions on how to set up the  \\n// WSDL link and create \\\"$token\\\" and \\\"$client,\\\"\\n// see: http://wiki.eBizCharge.com/developer/soap/howto/php\\n  $BatchStatus=$this->client->getBatchStatus($this->token, $BatchRefNum);\\n  echo $BatchStatus->Status;\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"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\": \"eBizCharge.BatchStatus result = new eBizCharge.BatchStatus();\\n           try\\n           {\\n               result = client.getBatchStatus(token, BatchRefNum);\\n               MessageBox.Show(string.Concat(result.Status));\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<getBatchStatusReturn xsi:type=\\\"ns1:BatchStatus\\\">\\n<BatchRefNum xsi:type=\\\"xsd:integer\\\">1936</BatchRefNum>\\n<Closed xsi:type=\\\"xsd:string\\\"></Closed>\\n<CreditsAmount xsi:type=\\\"xsd:double\\\">0</CreditsAmount>\\n<CreditsCount xsi:type=\\\"xsd:integer\\\">0</CreditsCount>\\n<NetAmount xsi:type=\\\"xsd:double\\\">245</NetAmount>\\n<Opened xsi:type=\\\"xsd:string\\\">04/30/2008T11:26:15</Opened>\\n<SalesAmount xsi:type=\\\"xsd:double\\\">245</SalesAmount>\\n<SalesCount xsi:type=\\\"xsd:integer\\\">20</SalesCount>\\n<Scheduled xsi:type=\\\"xsd:string\\\"></Scheduled>\\n<Sequence xsi:type=\\\"xsd:integer\\\">1</Sequence>\\n<Status xsi:type=\\\"xsd:string\\\">Open</Status>\\n<TransactionCount xsi:type=\\\"xsd:integer\\\">20</TransactionCount>\\n<VoidsAmount xsi:type=\\\"xsd:double\\\">0</VoidsAmount>\\n<VoidsCount xsi:type=\\\"xsd:integer\\\">0</VoidsCount>\\n</getBatchStatusReturn>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"batchstatus","type":"basic","title":"BatchStatus"}
Contains information about a batch awaiting settlement. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object contains information about a batch of transactions that has been authorized and is awaiting settlement. It is returned when attempting to determine the status of a batch using the [getBatchStatus](/docs/getbatchstatus) method. This should reflect the same information contained in the Batch Manager section of the merchant console. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "Integer", "0-1": "BatchRefNum", "0-2": "Batch reference number (assigned by the gateway).", "1-0": "Integer", "1-1": "Sequence", "1-2": "Batch sequence number", "2-0": "String", "2-1": "Status", "2-2": "Status of this batch (ie: open, closing, closed)", "3-0": "String", "3-1": "Opened", "3-2": "Date/time the batch was opened (first transaction was run)", "4-0": "String", "4-1": "Closed", "4-2": "Date/time the batch was closed (if it has been closed)", "5-0": "String", "5-1": "Scheduled", "5-2": "Date/time the batch is scheduled to close", "6-0": "Integer", "6-1": "TransactionCount", "6-2": "Number of transactions in the batch", "7-0": "Integer", "7-1": "SalesCount", "7-2": "Number of sales in the batch", "8-0": "Integer", "8-1": "CreditsCount", "8-2": "Number of credits in the batch", "9-0": "Integer", "9-1": "VoidsCount", "9-2": "Number of voids in the batch", "10-0": "Double", "10-1": "SalesAmount", "10-2": "Dollar amount of the sales", "11-0": "Double", "11-1": "CreditsAmount", "11-2": "Dollar amount of the credits", "12-0": "Double", "12-1": "NetAmount", "12-2": "Dollar amount of the sales-credits", "13-0": "Double", "13-1": "VoidsAmount", "13-2": "Dollar amount of the voids" }, "cols": 3, "rows": 14 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\n// for directions on how to set up the \n// WSDL link and create \"$token\" and \"$client,\"\n// see: http://wiki.eBizCharge.com/developer/soap/howto/php\n $BatchStatus=$this->client->getBatchStatus($this->token, $BatchRefNum);\n echo $BatchStatus->Status;\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "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": "eBizCharge.BatchStatus result = new eBizCharge.BatchStatus();\n try\n {\n result = client.getBatchStatus(token, BatchRefNum);\n MessageBox.Show(string.Concat(result.Status));\n }", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "<getBatchStatusReturn xsi:type=\"ns1:BatchStatus\">\n<BatchRefNum xsi:type=\"xsd:integer\">1936</BatchRefNum>\n<Closed xsi:type=\"xsd:string\"></Closed>\n<CreditsAmount xsi:type=\"xsd:double\">0</CreditsAmount>\n<CreditsCount xsi:type=\"xsd:integer\">0</CreditsCount>\n<NetAmount xsi:type=\"xsd:double\">245</NetAmount>\n<Opened xsi:type=\"xsd:string\">04/30/2008T11:26:15</Opened>\n<SalesAmount xsi:type=\"xsd:double\">245</SalesAmount>\n<SalesCount xsi:type=\"xsd:integer\">20</SalesCount>\n<Scheduled xsi:type=\"xsd:string\"></Scheduled>\n<Sequence xsi:type=\"xsd:integer\">1</Sequence>\n<Status xsi:type=\"xsd:string\">Open</Status>\n<TransactionCount xsi:type=\"xsd:integer\">20</TransactionCount>\n<VoidsAmount xsi:type=\"xsd:double\">0</VoidsAmount>\n<VoidsCount xsi:type=\"xsd:integer\">0</VoidsCount>\n</getBatchStatusReturn>", "language": "xml" } ] } [/block]