{"_id":"5632a5e849e16d0d00122461","githubsync":"","user":"55b932ba8fd1a02b00f496c8","__v":0,"category":{"_id":"5632a5e749e16d0d00122445","project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","__v":1,"pages":["5632a5e849e16d0d00122460","5632a5e849e16d0d00122461","5632a5e849e16d0d00122462","5632a5e849e16d0d00122463","5632a5e849e16d0d00122464","5632a5e849e16d0d00122465","5632a5e849e16d0d00122466","5632a5e849e16d0d00122467","5632a5e849e16d0d00122468","5632a5e849e16d0d00122469","5632a5e849e16d0d0012246a","5632a5e849e16d0d0012246b","5632a5e849e16d0d0012246c","5632a5e849e16d0d0012246d","5632a5e849e16d0d0012246e","5632a5e849e16d0d0012246f","5632a5e849e16d0d00122470","5632a5e849e16d0d00122471","5632a5e849e16d0d00122472","5632a5e849e16d0d00122473","5632a5e849e16d0d00122474","5632a5e849e16d0d00122475","5632a5e849e16d0d00122476","5632a5e849e16d0d00122477"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-31T23:43:21.882Z","from_sync":false,"order":3,"slug":"transactions","title":"Transactions"},"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-07-31T23:44:07.995Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"This method provides a Soap based interface to the Transaction API.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThe parameters argument is an array containing any of the variable names supported by the Transaction API.\nThis method requires more work to implement than the [runTransaction ](/docs/run-transactions)method, and typically should not be your first choice for processing transactions. The one benefit of using this method is that it provides a direct interface to the transaction processing engine of the gateway. As new fields are added to the system they can be used immediately via this method without having to wait for the next Soap release or generate a new WSDL link. The [runTransaction ](/docs/run-transactions)method on the other hand has its [TransactionRequestObject ](/docs/transactionrequestobject)tied to the Soap release (and wsdl url). To access new fields you would have to generate a new WSDL link.\n*NOTE*: In previous releases this method was called runOldApi.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nTransactionResponse runTransactionAPI ( [ueSecurityToken](/docs/uesecuritytoken) Token, [FieldValue](/docs/fieldvalue) Parameters )\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\": \"[FieldValue](/docs/fieldvalue)\",\n    \"1-1\": \"Parameters\",\n    \"1-2\": \"List of variables to pass to Transaction API.\"\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 a TransactionResponse object containing the results of the transaction and all relevant data.\",\n    \"0-0\": \"[TransactionResponse](/docs/transactionresponse)\"\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\\n $Request=array(\\n   array('Field'=>'UMname', 'Value'=>'Tester Jones'),\\n   array('Field'=>'UMdescription', 'Value'=>'runTrasactionAPI sale'),\\n   array('Field'=>'UMamount', 'Value'=>'3.51'),\\n   array('Field'=>'UMinvoice', 'Value'=>'12345'),\\n   array('Field'=>'UMcard', 'Value'=>'4444555566667779'),\\n   array('Field'=>'UMexpir', 'Value'=>'0909'),\\n   array('Field'=>'UMstreet', 'Value'=>'1234 Main Street'),\\n   array('Field'=>'UMzip', 'Value'=>'99281'),\\n   array('Field'=>'UMcvv2', 'Value'=>'444')\\n  );\\n $res=$client->runTransactionAPI($token, $Request);\\n print_r($res);\\n\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim client As eBizCharge.eBizChargeService = New eBizCharge.eBizChargeService\\n       Dim token As eBizCharge.ueSecurityToken\\n       token = Me.CreateToken(\\\"714SSUxv1uohng2XkMJ7kLpETsu58G66\\\", \\\"1234\\\")\\n       Dim Fields(0 To 9) As eBizCharge.FieldValue\\n       Dim i As Integer\\n       For i = 0 To 9\\n           Fields(i) = New eBizCharge.FieldValue\\n       Next i\\n       Fields(0).Field = \\\"UMname\\\"\\n       Fields(0).Value = \\\"Tester Jones\\\"\\n       Fields(1).Field = \\\"UMdescription\\\"\\n       Fields(1).Value = \\\"Visual Basic For Dummies\\\"\\n       Fields(2).Field = \\\"UMamount\\\"\\n       Fields(2).Value = \\\"1.00\\\"\\n       Fields(3).Field = \\\"UMinvoice\\\"\\n       Fields(3).Value = \\\"12345\\\"\\n       Fields(4).Field = \\\"UMcard\\\"\\n       Fields(4).Value = \\\"4444555566667779\\\"\\n       Fields(5).Field = \\\"UMexpir\\\"\\n       Fields(5).Value = \\\"1212\\\"\\n       Fields(6).Field = \\\"UMstreet\\\"\\n       Fields(6).Value = \\\"1234 Main Street\\\"\\n       Fields(7).Field = \\\"UMzip\\\"\\n       Fields(7).Value = \\\"90210\\\"\\n       Fields(8).Field = \\\"UMcvv2\\\"\\n       Fields(8).Value = \\\"999\\\"\\n       Dim response As eBizCharge.TransactionResponse\\n       response = client.runTransactionAPI(token, Fields)\\n       MsgBox(\\\"Reference Number: \\\" & response.RefNum)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.FieldValue[] tran = new eBizCharge.FieldValue[9];\\n           for (int i = 0; i < 9; i++)\\n           {\\n               tran[i] = new eBizCharge.FieldValue();\\n           }\\n           tran[0].Field = \\\"UMname\\\";           tran[0].Value = \\\"Tester Jones\\\";\\n           tran[1].Field = \\\"UMdescription\\\";    tran[1].Value = \\\"runTransactionAPI sale\\\";\\n           tran[2].Field = \\\"UMamount\\\";         tran[2].Value = \\\"1.00\\\";\\n           tran[3].Field = \\\"UMinvoice\\\";        tran[3].Value = \\\"12345\\\";\\n           tran[4].Field = \\\"UMcard\\\";           tran[4].Value = \\\"4444555566667779\\\";\\n           tran[5].Field = \\\"UMexpir\\\";          tran[5].Value = \\\"1212\\\";\\n           tran[6].Field = \\\"UMstreet\\\";         tran[6].Value = \\\"123 Main Street\\\";\\n           tran[7].Field = \\\"UMzip\\\";            tran[7].Value = \\\"90046\\\";\\n           tran[8].Field = \\\"UMcvv2\\\";           tran[8].Value = \\\"999\\\";\\n           eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\\n           try\\n           {\\n               response = client.runTransactionAPI(token, tran);\\n               if (response.ResultCode == \\\"A\\\")\\n               {\\n                   MessageBox.Show(string.Concat(\\\"Transaction Approved, RefNum: \\\",\\n                           response.RefNum));\\n               }\\n               else\\n               {\\n                   MessageBox.Show(string.Concat(\\\"Transaction Failed: \\\",\\n                           response.Error));\\n               }\\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:runTransactionAPI>\\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<Parameters SOAP-ENC:arrayType=\\\"ns1:FieldValue[9]\\\" xsi:type=\\\"ns1:FieldValueArray\\\">\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n<Field xsi:type=\\\"xsd:string\\\">UMname</Field>\\n<Value xsi:type=\\\"xsd:string\\\">Tester Jones</Value>\\n</item>\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n<Field xsi:type=\\\"xsd:string\\\">UMdescription</Field>\\n<Value xsi:type=\\\"xsd:string\\\">runTrasactionAPI sale</Value>\\n</item>\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n<Field xsi:type=\\\"xsd:string\\\">UMamount</Field>\\n<Value xsi:type=\\\"xsd:string\\\">3.51</Value>\\n</item>\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n<Field xsi:type=\\\"xsd:string\\\">UMinvoice</Field>\\n<Value xsi:type=\\\"xsd:string\\\">12345</Value>\\n</item>\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n<Field xsi:type=\\\"xsd:string\\\">UMcard</Field>\\n<Value xsi:type=\\\"xsd:string\\\">4444555566667779</Value>\\n</item>\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n<Field xsi:type=\\\"xsd:string\\\">UMexpir</Field>\\n<Value xsi:type=\\\"xsd:string\\\">1212</Value>\\n</item>\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n<Field xsi:type=\\\"xsd:string\\\">UMstreet</Field>\\n<Value xsi:type=\\\"xsd:string\\\">1234 Main Street</Value>\\n</item>\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n<Field xsi:type=\\\"xsd:string\\\">UMzip</Field>\\n<Value xsi:type=\\\"xsd:string\\\">99281</Value>\\n</item>\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n<Field xsi:type=\\\"xsd:string\\\">UMcvv2</Field>\\n<Value xsi:type=\\\"xsd:string\\\">444</Value>\\n</item>\\n</Parameters>\\n</ns1:runTransactionAPI>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope> this method.\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"run-transactionapi","type":"basic","title":"runTransactionAPI"}
This method provides a Soap based interface to the Transaction API. [block:api-header] { "type": "basic", "title": "Description" } [/block] The parameters argument is an array containing any of the variable names supported by the Transaction API. This method requires more work to implement than the [runTransaction ](/docs/run-transactions)method, and typically should not be your first choice for processing transactions. The one benefit of using this method is that it provides a direct interface to the transaction processing engine of the gateway. As new fields are added to the system they can be used immediately via this method without having to wait for the next Soap release or generate a new WSDL link. The [runTransaction ](/docs/run-transactions)method on the other hand has its [TransactionRequestObject ](/docs/transactionrequestobject)tied to the Soap release (and wsdl url). To access new fields you would have to generate a new WSDL link. *NOTE*: In previous releases this method was called runOldApi. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] TransactionResponse runTransactionAPI ( [ueSecurityToken](/docs/uesecuritytoken) Token, [FieldValue](/docs/fieldvalue) Parameters ) [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": "[FieldValue](/docs/fieldvalue)", "1-1": "Parameters", "1-2": "List of variables to pass to Transaction API." }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-1": "Returns a TransactionResponse object containing the results of the transaction and all relevant data.", "0-0": "[TransactionResponse](/docs/transactionresponse)" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\n $Request=array(\n array('Field'=>'UMname', 'Value'=>'Tester Jones'),\n array('Field'=>'UMdescription', 'Value'=>'runTrasactionAPI sale'),\n array('Field'=>'UMamount', 'Value'=>'3.51'),\n array('Field'=>'UMinvoice', 'Value'=>'12345'),\n array('Field'=>'UMcard', 'Value'=>'4444555566667779'),\n array('Field'=>'UMexpir', 'Value'=>'0909'),\n array('Field'=>'UMstreet', 'Value'=>'1234 Main Street'),\n array('Field'=>'UMzip', 'Value'=>'99281'),\n array('Field'=>'UMcvv2', 'Value'=>'444')\n );\n $res=$client->runTransactionAPI($token, $Request);\n print_r($res);\n", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim client As eBizCharge.eBizChargeService = New eBizCharge.eBizChargeService\n Dim token As eBizCharge.ueSecurityToken\n token = Me.CreateToken(\"714SSUxv1uohng2XkMJ7kLpETsu58G66\", \"1234\")\n Dim Fields(0 To 9) As eBizCharge.FieldValue\n Dim i As Integer\n For i = 0 To 9\n Fields(i) = New eBizCharge.FieldValue\n Next i\n Fields(0).Field = \"UMname\"\n Fields(0).Value = \"Tester Jones\"\n Fields(1).Field = \"UMdescription\"\n Fields(1).Value = \"Visual Basic For Dummies\"\n Fields(2).Field = \"UMamount\"\n Fields(2).Value = \"1.00\"\n Fields(3).Field = \"UMinvoice\"\n Fields(3).Value = \"12345\"\n Fields(4).Field = \"UMcard\"\n Fields(4).Value = \"4444555566667779\"\n Fields(5).Field = \"UMexpir\"\n Fields(5).Value = \"1212\"\n Fields(6).Field = \"UMstreet\"\n Fields(6).Value = \"1234 Main Street\"\n Fields(7).Field = \"UMzip\"\n Fields(7).Value = \"90210\"\n Fields(8).Field = \"UMcvv2\"\n Fields(8).Value = \"999\"\n Dim response As eBizCharge.TransactionResponse\n response = client.runTransactionAPI(token, Fields)\n MsgBox(\"Reference Number: \" & response.RefNum)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.FieldValue[] tran = new eBizCharge.FieldValue[9];\n for (int i = 0; i < 9; i++)\n {\n tran[i] = new eBizCharge.FieldValue();\n }\n tran[0].Field = \"UMname\"; tran[0].Value = \"Tester Jones\";\n tran[1].Field = \"UMdescription\"; tran[1].Value = \"runTransactionAPI sale\";\n tran[2].Field = \"UMamount\"; tran[2].Value = \"1.00\";\n tran[3].Field = \"UMinvoice\"; tran[3].Value = \"12345\";\n tran[4].Field = \"UMcard\"; tran[4].Value = \"4444555566667779\";\n tran[5].Field = \"UMexpir\"; tran[5].Value = \"1212\";\n tran[6].Field = \"UMstreet\"; tran[6].Value = \"123 Main Street\";\n tran[7].Field = \"UMzip\"; tran[7].Value = \"90046\";\n tran[8].Field = \"UMcvv2\"; tran[8].Value = \"999\";\n eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\n try\n {\n response = client.runTransactionAPI(token, tran);\n if (response.ResultCode == \"A\")\n {\n MessageBox.Show(string.Concat(\"Transaction Approved, RefNum: \",\n response.RefNum));\n }\n else\n {\n MessageBox.Show(string.Concat(\"Transaction Failed: \",\n response.Error));\n }\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:runTransactionAPI>\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<Parameters SOAP-ENC:arrayType=\"ns1:FieldValue[9]\" xsi:type=\"ns1:FieldValueArray\">\n<item xsi:type=\"ns1:FieldValue\">\n<Field xsi:type=\"xsd:string\">UMname</Field>\n<Value xsi:type=\"xsd:string\">Tester Jones</Value>\n</item>\n<item xsi:type=\"ns1:FieldValue\">\n<Field xsi:type=\"xsd:string\">UMdescription</Field>\n<Value xsi:type=\"xsd:string\">runTrasactionAPI sale</Value>\n</item>\n<item xsi:type=\"ns1:FieldValue\">\n<Field xsi:type=\"xsd:string\">UMamount</Field>\n<Value xsi:type=\"xsd:string\">3.51</Value>\n</item>\n<item xsi:type=\"ns1:FieldValue\">\n<Field xsi:type=\"xsd:string\">UMinvoice</Field>\n<Value xsi:type=\"xsd:string\">12345</Value>\n</item>\n<item xsi:type=\"ns1:FieldValue\">\n<Field xsi:type=\"xsd:string\">UMcard</Field>\n<Value xsi:type=\"xsd:string\">4444555566667779</Value>\n</item>\n<item xsi:type=\"ns1:FieldValue\">\n<Field xsi:type=\"xsd:string\">UMexpir</Field>\n<Value xsi:type=\"xsd:string\">1212</Value>\n</item>\n<item xsi:type=\"ns1:FieldValue\">\n<Field xsi:type=\"xsd:string\">UMstreet</Field>\n<Value xsi:type=\"xsd:string\">1234 Main Street</Value>\n</item>\n<item xsi:type=\"ns1:FieldValue\">\n<Field xsi:type=\"xsd:string\">UMzip</Field>\n<Value xsi:type=\"xsd:string\">99281</Value>\n</item>\n<item xsi:type=\"ns1:FieldValue\">\n<Field xsi:type=\"xsd:string\">UMcvv2</Field>\n<Value xsi:type=\"xsd:string\">444</Value>\n</item>\n</Parameters>\n</ns1:runTransactionAPI>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope> this method.", "language": "xml" } ] } [/block]