{"_id":"5632a5e849e16d0d0012247c","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"},"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"},"githubsync":"","__v":0,"project":"55b933b3146ef121002158d3","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:11:46.574Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"Retrieve transactions in the batch specified by BatchRefNum,\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method will return all of the transactions contained within the specified batch. Use this method to retrieve all transaction data including status, type, amount, response and customer information.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[transactionObject](/docs/transactionobject)[] **getBatchTransactions** ( [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\": \"Returns an array of TransactionObjects for all transactions in the specified batch\",\n    \"0-0\": \"[transactionObject](/docs/transactionobject)[]\"\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 //Set BatchRefNum to the Batch Reference Number of the batch you want\\n //to retrieve transactions from.  0 is always the current batch\\n $BatchRefNum=0;\\n $Result=$client->getBatchTransactions($token, $BatchRefNum);  \\n}\\ncatch (SoapFault $e) {\\n die(\\\"get Batch Transactions 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 you want\\n //to retrieve transactions from.  0 is always the current batch\\n BigInteger BatchNum = new BigInteger(\\\"0\\\");\\n TransactionObjectArray ResultSet = new TransactionObjectArray();\\n ResultSet = client.getBatchTransactions(token, BatchNum);\\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' Set BatchRefNum to 0 to get the current batch.  \\n' Otherwise use batch reference num  (can be found in  Transaction.Details.BatchRefNum)\\nBatchRefNum = \\\"0\\\"\\nDim transactions() As eBizCharge.TransactionObject = client.getBatchTransactions(token, BatchRefNum)\\nMsgBox(\\\"Found \\\" & transactions.Length & \\\" transactions in current batch\\\")\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string BatchRefNum = \\\"9581\\\";\\n           try\\n           {\\n               eBizCharge.TransactionObject[] tran = client.getBatchTransactions(token, BatchRefNum);\\n               MessageBox.Show(string.Concat(\\\"Found \\\",tran.Length));\\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:getBatchTransactions>\\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:getBatchTransactions>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getbatchtransactions","type":"basic","title":"getBatchTransactions"}

getBatchTransactions


Retrieve transactions in the batch specified by BatchRefNum, [block:api-header] { "type": "basic", "title": "Description" } [/block] This method will return all of the transactions contained within the specified batch. Use this method to retrieve all transaction data including status, type, amount, response and customer information. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [transactionObject](/docs/transactionobject)[] **getBatchTransactions** ( [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": "Returns an array of TransactionObjects for all transactions in the specified batch", "0-0": "[transactionObject](/docs/transactionobject)[]" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n //Set BatchRefNum to the Batch Reference Number of the batch you want\n //to retrieve transactions from. 0 is always the current batch\n $BatchRefNum=0;\n $Result=$client->getBatchTransactions($token, $BatchRefNum); \n}\ncatch (SoapFault $e) {\n die(\"get Batch Transactions 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 you want\n //to retrieve transactions from. 0 is always the current batch\n BigInteger BatchNum = new BigInteger(\"0\");\n TransactionObjectArray ResultSet = new TransactionObjectArray();\n ResultSet = client.getBatchTransactions(token, BatchNum);\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' Set BatchRefNum to 0 to get the current batch. \n' Otherwise use batch reference num (can be found in Transaction.Details.BatchRefNum)\nBatchRefNum = \"0\"\nDim transactions() As eBizCharge.TransactionObject = client.getBatchTransactions(token, BatchRefNum)\nMsgBox(\"Found \" & transactions.Length & \" transactions in current batch\")", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string BatchRefNum = \"9581\";\n try\n {\n eBizCharge.TransactionObject[] tran = client.getBatchTransactions(token, BatchRefNum);\n MessageBox.Show(string.Concat(\"Found \",tran.Length));\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:getBatchTransactions>\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:getBatchTransactions>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]