{"_id":"5632a5e849e16d0d00122460","user":"55b932ba8fd1a02b00f496c8","__v":3,"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"},"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"},"githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-31T23:43:49.415Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Runs a transaction using the Transaction API.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method duplicates the functionality of the gateway API. It can be used to run a wide variety of transaction types including sales, credits, authonly, void, and checks.\nThe parameters argument is a TransactionRequestObject containing any of the variable names supported by the Transaction API (See the docs for a list of valid field names). Make sure to remove the UM from the front of the field names. (ie: UMamount should be passed as Amount.)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[TransactionResponse](/docs/transactionresponse) runTransaction ( [ueSecurityToken ](/docs/uesecuritytoken)Token, [TransactionRequestObject](/docs/transactionrequestobject) 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    \"1-0\": \"[TransactionRequestObject](/docs/transactionrequestobject)\",\n    \"2-0\": \"\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and validate transaction.\",\n    \"1-1\": \"Parameters\",\n    \"1-2\": \"Request transaction details from all fields of the transaction form, including reference number, transaction amount, customer ID, currency, authorization code, and any other information entered at the time of the transaction.\"\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\\ntry {\\n $Request=array(\\n   'AccountHolder' => 'Tester Jones',\\n   'Details' => array(\\n     'Description' => 'Example Transaction',\\n     'Amount' => '4.00',\\n     'Invoice' => '44539'\\n   ),\\n   'CreditCardData' => array(\\n     'CardNumber' => '4444555566667779',\\n     'CardExpiration' => '0909',\\n     'AvsStreet' => '1234 Main Street',\\n     'AvsZip' => '99281',\\n     'CardCode' => '999'\\n   )\\n );\\n $res=$client->runTransaction($token, $Request);\\n print_r($res);\\n}\\ncatch (SoapFault $e){\\n echo $client->__getLastRequest();\\n echo $client->__getLastResponse();\\n die(\\\"runTransaction failed :\\\" .$e->getMessage());\\n}\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Java \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"try {\\n TransactionRequestObject params = new TransactionRequestObject();\\n // set card holder name\\n   params.setAccountHolder(\\\"Test Joe\\\");\\n   params.setCommand(\\\"Sale\\\");\\n // populate transaction details\\n TransactionDetail details = new TransactionDetail();\\n     details.setAmount(22.34);\\n     details.setDescription(\\\"My Test Sale\\\");\\n     details.setInvoice(\\\"119891\\\");\\n   params.setDetails(details);\\n // populate credit card data\\n CreditCardData ccdata = new CreditCardData();\\n     ccdata.setCardNumber(\\\"4444555566667779\\\");\\n     ccdata.setCardExpiration(\\\"0912\\\");\\n     ccdata.setCardCode(\\\"999\\\");\\n   params.setCreditCardData(ccdata);\\n // Create request object\\n RunTransaction request = new RunTransaction();\\n   request.setToken(token);\\n // Create response object\\n TransactionResponse response;\\n // run transaction\\n response = client.runTransaction(token, params);\\n System.out.println(\\\"Result: \\\" + response.getResult());\\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 client As eBizCharge.eBizChargeService = New eBizCharge.eBizChargeService\\n       Dim token As eBizCharge.ueSecurityToken\\n       token = Me.CreateToken(\\\"714SSUxv1uohng2XkMJ7kLpETsu58G66\\\", \\\"1234\\\")\\n       Dim tran As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\\n       tran.CreditCardData = New eBizCharge.CreditCardData\\n       tran.CreditCardData.CardNumber = \\\"4444555566667779\\\"\\n       tran.CreditCardData.CardExpiration = \\\"0913\\\"\\n       tran.CreditCardData.CardCode = \\\"999\\\"\\n       tran.Details = New eBizCharge.TransactionDetail\\n       tran.Details.Amount = 9.02\\n       tran.Details.AmountSpecified = True\\n       tran.Details.Invoice = \\\"434534\\\"\\n       tran.Details.Description = \\\"Example transaction\\\"\\n       tran.Command = \\\"sale\\\"\\n       Dim response As eBizCharge.TransactionResponse\\n       response = client.runTransaction(token, tran)\\n       If response.ResultCode = \\\"A\\\" Then\\n           MsgBox(\\\"Transaction Approved, Refernce Number: \\\" & response.RefNum)\\n       ElseIf response.ResultCode = \\\"D\\\" Then\\n           MsgBox(\\\"Transaction Declined, Reason: \\\" & response.Error)\\n       Else\\n           MsgBox(\\\"Transaction Error, Reason: \\\" & response.Error)\\n       End If\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();\\ntran.Command = \\\"cc:sale\\\";\\ntran.Details =  new eBizCharge.TransactionDetail();\\ntran.Details.Amount = 1.00;\\ntran.Details.AmountSpecified = true;\\ntran.Details.Invoice = \\\"1234\\\";\\ntran.Details.Description = \\\"Example Transaction\\\";\\ntran.CreditCardData = new eBizCharge.CreditCardData();\\ntran.CreditCardData.CardNumber = \\\"4444555566667779\\\";\\ntran.CreditCardData.CardExpiration = \\\"0909\\\";\\neBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\\ntry\\n{\\n   response = client.runTransaction(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}\\ncatch (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/\\\" SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:runTransaction>\\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 xsi:type=\\\"ns1:TransactionRequestObject\\\">\\n<AccountHolder xsi:type=\\\"xsd:string\\\">Tester Jones</AccountHolder>\\n<CreditCardData xsi:type=\\\"ns1:CreditCardData\\\">\\n<AvsStreet xsi:type=\\\"xsd:string\\\">1234 Main Street</AvsStreet>\\n<AvsZip xsi:type=\\\"xsd:string\\\">99281</AvsZip>\\n<CardCode xsi:type=\\\"xsd:string\\\">999</CardCode>\\n<CardExpiration xsi:type=\\\"xsd:string\\\">1212</CardExpiration>\\n<CardNumber xsi:type=\\\"xsd:string\\\">4444555566667779</CardNumber>\\n</CreditCardData>\\n<Details xsi:type=\\\"ns1:TransactionDetail\\\">\\n<Amount xsi:type=\\\"xsd:double\\\">4</Amount>\\n<Description xsi:type=\\\"xsd:string\\\">Example Transaction</Description>\\n<Invoice xsi:type=\\\"xsd:string\\\">44539</Invoice>\\n</Details>\\n</Parameters>\\n</ns1:runTransaction>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"run-transactions","type":"basic","title":"runTransaction"}
Runs a transaction using the Transaction API. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method duplicates the functionality of the gateway API. It can be used to run a wide variety of transaction types including sales, credits, authonly, void, and checks. The parameters argument is a TransactionRequestObject containing any of the variable names supported by the Transaction API (See the docs for a list of valid field names). Make sure to remove the UM from the front of the field names. (ie: UMamount should be passed as Amount.) [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [TransactionResponse](/docs/transactionresponse) runTransaction ( [ueSecurityToken ](/docs/uesecuritytoken)Token, [TransactionRequestObject](/docs/transactionrequestobject) 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)", "1-0": "[TransactionRequestObject](/docs/transactionrequestobject)", "2-0": "", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and validate transaction.", "1-1": "Parameters", "1-2": "Request transaction details from all fields of the transaction form, including reference number, transaction amount, customer ID, currency, authorization code, and any other information entered at the time of the transaction." }, "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\ntry {\n $Request=array(\n 'AccountHolder' => 'Tester Jones',\n 'Details' => array(\n 'Description' => 'Example Transaction',\n 'Amount' => '4.00',\n 'Invoice' => '44539'\n ),\n 'CreditCardData' => array(\n 'CardNumber' => '4444555566667779',\n 'CardExpiration' => '0909',\n 'AvsStreet' => '1234 Main Street',\n 'AvsZip' => '99281',\n 'CardCode' => '999'\n )\n );\n $res=$client->runTransaction($token, $Request);\n print_r($res);\n}\ncatch (SoapFault $e){\n echo $client->__getLastRequest();\n echo $client->__getLastResponse();\n die(\"runTransaction failed :\" .$e->getMessage());\n}", "language": "php" } ] } [/block] ## Java [block:code] { "codes": [ { "code": "try {\n TransactionRequestObject params = new TransactionRequestObject();\n // set card holder name\n params.setAccountHolder(\"Test Joe\");\n params.setCommand(\"Sale\");\n // populate transaction details\n TransactionDetail details = new TransactionDetail();\n details.setAmount(22.34);\n details.setDescription(\"My Test Sale\");\n details.setInvoice(\"119891\");\n params.setDetails(details);\n // populate credit card data\n CreditCardData ccdata = new CreditCardData();\n ccdata.setCardNumber(\"4444555566667779\");\n ccdata.setCardExpiration(\"0912\");\n ccdata.setCardCode(\"999\");\n params.setCreditCardData(ccdata);\n // Create request object\n RunTransaction request = new RunTransaction();\n request.setToken(token);\n // Create response object\n TransactionResponse response;\n // run transaction\n response = client.runTransaction(token, params);\n System.out.println(\"Result: \" + response.getResult());\n} catch (Exception e) {\n System.out.println(\"Soap Exception: \" + e.getMessage());\n}", "language": "java" } ] } [/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 tran As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\n tran.CreditCardData = New eBizCharge.CreditCardData\n tran.CreditCardData.CardNumber = \"4444555566667779\"\n tran.CreditCardData.CardExpiration = \"0913\"\n tran.CreditCardData.CardCode = \"999\"\n tran.Details = New eBizCharge.TransactionDetail\n tran.Details.Amount = 9.02\n tran.Details.AmountSpecified = True\n tran.Details.Invoice = \"434534\"\n tran.Details.Description = \"Example transaction\"\n tran.Command = \"sale\"\n Dim response As eBizCharge.TransactionResponse\n response = client.runTransaction(token, tran)\n If response.ResultCode = \"A\" Then\n MsgBox(\"Transaction Approved, Refernce Number: \" & response.RefNum)\n ElseIf response.ResultCode = \"D\" Then\n MsgBox(\"Transaction Declined, Reason: \" & response.Error)\n Else\n MsgBox(\"Transaction Error, Reason: \" & response.Error)\n End If", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();\ntran.Command = \"cc:sale\";\ntran.Details = new eBizCharge.TransactionDetail();\ntran.Details.Amount = 1.00;\ntran.Details.AmountSpecified = true;\ntran.Details.Invoice = \"1234\";\ntran.Details.Description = \"Example Transaction\";\ntran.CreditCardData = new eBizCharge.CreditCardData();\ntran.CreditCardData.CardNumber = \"4444555566667779\";\ntran.CreditCardData.CardExpiration = \"0909\";\neBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\ntry\n{\n response = client.runTransaction(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}\ncatch (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/\" SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:runTransaction>\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 xsi:type=\"ns1:TransactionRequestObject\">\n<AccountHolder xsi:type=\"xsd:string\">Tester Jones</AccountHolder>\n<CreditCardData xsi:type=\"ns1:CreditCardData\">\n<AvsStreet xsi:type=\"xsd:string\">1234 Main Street</AvsStreet>\n<AvsZip xsi:type=\"xsd:string\">99281</AvsZip>\n<CardCode xsi:type=\"xsd:string\">999</CardCode>\n<CardExpiration xsi:type=\"xsd:string\">1212</CardExpiration>\n<CardNumber xsi:type=\"xsd:string\">4444555566667779</CardNumber>\n</CreditCardData>\n<Details xsi:type=\"ns1:TransactionDetail\">\n<Amount xsi:type=\"xsd:double\">4</Amount>\n<Description xsi:type=\"xsd:string\">Example Transaction</Description>\n<Invoice xsi:type=\"xsd:string\">44539</Invoice>\n</Details>\n</Parameters>\n</ns1:runTransaction>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]