{"_id":"5632a5e849e16d0d00122466","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","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"},"user":"55b932ba8fd1a02b00f496c8","githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T17:47:28.487Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"Run a check credit transaction.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method uses ACH to sends funds to a customer, employee, vendor, etc. It can be used to “refund” a sale or make a payment to someone (ie payroll). This transaction type is “stand alone” and does not pull the account and routing number from a previous sale. You must provide the Routing and Account properties in the CheckData object. If you want to use the account data from a prior transaction by referencing the RefNum, use the [refundTransaction]( /docs/refund-transactions) or [runQuickCredit]( /docs/runquicksale) methods.\nThis feature, sometimes referred as “Reverse ACH”, “Check Credit” or “Disbursement”, is not available with all check processors. For those processors that do support it, merchants must request that it is enabled for their account. Contact your merchant service provider for further information.\nIf this method is used to reverse or refund an electronic check transaction, please be aware that both the original transaction and the refund will appear as separate transactions on the customer's bank account statement. To reverse a sale without creating a new transaction, you must use the [voidTransaction]( /docs/void-transactions) method. Please see the description of the [voidTransaction]( /docs/void-transactions) method for more details on how to determine which of these methods is most appropriate.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[TransactionResponse](/docs/transactionresponse) **runCheckCredit** ( [ueSecurityToken](/docs/uesecuritytoken) Token, [TransactionRequestObject](/docs/transactionrequestobject) Params )\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\": \"[TransactionRequestObject](/docs/transactionrequestobject)\",\n    \"1-1\": \"Params\",\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.99',\\n     'Invoice' => '44539'\\n     ),\\n   'CheckData' => array(\\n     'CheckNumber' => '1234',\\n     'Routing' => '123456789',\\n     'Account' => '11111111',\\n     'AccountType' => 'Savings',\\n     'DriversLicense' => '34521343',\\n     'DriversLicenseState' => 'CA',\\n     'RecordType' => 'PPD'\\n     )\\n   );\\n $res=$client->runCheckCredit($token, $Request);\\n}  \\ncatch (SoapFault $e)  {\\n echo $client->__getLastRequest();\\n echo $client->__getLastResponse();\\n die(\\\"runCheckCredit 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 TransactionRequestObject params = new TransactionRequestObject();\\n //set account holder name\\n   params.setAccountHolder(\\\"Test Joe\\\");\\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   CheckData checkdata = new CheckData();\\n     checkdata.setRouting(\\\"123123123\\\");\\n     checkdata.setAccount(\\\"321321\\\");\\n   params.setCheckData(checkdata);\\n // Create request object\\n RunCheckCredit request = new RunCheckCredit();\\n   request.setToken(token);\\n   request.setParams(params);\\n // Create response object\\n TransactionResponse response;\\n // run credit\\n response = client.runCheckCredit(token, params);\\n System.out.println(\\\"Response: \\\" + response.getResult() + \\\" RefNum: \\\" + response.getRefNum());\\n} catch (Exception e) {\\n   System.out.println(\\\"Soap Exception: \\\" + e.getMessage());\\n}\\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 transaction As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\\n       transaction.CheckData = New eBizCharge.CheckData\\n       transaction.CheckData.Account = \\\"1112223333\\\"\\n       transaction.CheckData.Routing = \\\"123456789\\\"\\n       transaction.CheckData.DriversLicense = \\\"D5555555\\\"\\n       transaction.CheckData.DriversLicenseState = \\\"CA\\\"\\n       transaction.Details = New eBizCharge.TransactionDetail\\n       transaction.Details.Amount = \\\"1.00\\\"\\n       transaction.Details.AmountSpecified = True\\n       transaction.Details.Invoice = \\\"55555\\\"\\n       transaction.Details.Description = \\\"Test Check Sale\\\"\\n       transaction.AccountHolder = \\\"Test Guy\\\"\\n       Dim response As eBizCharge.TransactionResponse\\n       response = client.runCheckCredit(token, transaction)\\n       If response.ResultCode = \\\"A\\\" Then\\n           MsgBox(\\\"Transaction Approved, Reference 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\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();\\n           tran.Details = new eBizCharge.TransactionDetail();\\n           tran.Details.Amount = 1.00;\\n           tran.Details.AmountSpecified = true;\\n           tran.Details.Invoice = \\\"1234\\\";\\n           tran.Details.Description = \\\"Sample Check Credit\\\";\\n           tran.CheckData = new eBizCharge.CheckData();\\n           tran.CheckData.Account = \\\"1112223333\\\";\\n           tran.CheckData.Routing = \\\"123456789\\\";\\n           tran.CheckData.DriversLicense = \\\"D5555555\\\";\\n           tran.CheckData.DriversLicenseState = \\\"CA\\\";\\n           tran.AccountHolder = \\\"Test Guy\\\";\\n           eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\\n           try\\n           {\\n               response = client.runCheckCredit(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/\\\" xmlns:ns1=\\\"urn:eBizCharge\\\"\\nxmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\" xmlns: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:runCheckCredit>\\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<Params xsi:type=\\\"ns1:TransactionRequestObject\\\">\\n       <AccountHolder xsi:type=\\\"xsd:string\\\">Tester Jones 111</AccountHolder>\\n       <CheckData xsi:type=\\\"ns1:CheckData\\\">\\n               <Account xsi:type=\\\"xsd:string\\\">11111111</Account>\\n               <AccountType xsi:type=\\\"xsd:string\\\">Savings</AccountType>\\n               <CheckNumber xsi:type=\\\"xsd:integer\\\">1234</CheckNumber>\\n               <DriversLicense xsi:type=\\\"xsd:string\\\">34521343</DriversLicense>\\n               <DriversLicenseState xsi:type=\\\"xsd:string\\\">CA</DriversLicenseState>\\n               <RecordType xsi:type=\\\"xsd:string\\\">PPD</RecordType>\\n               <Routing xsi:type=\\\"xsd:string\\\">123456789</Routing>\\n       </CheckData>\\n       <Details xsi:type=\\\"ns1:TransactionDetail\\\">\\n               <Amount xsi:type=\\\"xsd:double\\\">4.99</Amount>\\n               <Description xsi:type=\\\"xsd:string\\\">Example Credit</Description>\\n               <Invoice xsi:type=\\\"xsd:string\\\">44539</Invoice>\\n       </Details>\\n</Params>\\n</ns1:runCheckCredit>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"runcheckcredit","type":"basic","title":"runCheckCredit"}
Run a check credit transaction. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method uses ACH to sends funds to a customer, employee, vendor, etc. It can be used to “refund” a sale or make a payment to someone (ie payroll). This transaction type is “stand alone” and does not pull the account and routing number from a previous sale. You must provide the Routing and Account properties in the CheckData object. If you want to use the account data from a prior transaction by referencing the RefNum, use the [refundTransaction]( /docs/refund-transactions) or [runQuickCredit]( /docs/runquicksale) methods. This feature, sometimes referred as “Reverse ACH”, “Check Credit” or “Disbursement”, is not available with all check processors. For those processors that do support it, merchants must request that it is enabled for their account. Contact your merchant service provider for further information. If this method is used to reverse or refund an electronic check transaction, please be aware that both the original transaction and the refund will appear as separate transactions on the customer's bank account statement. To reverse a sale without creating a new transaction, you must use the [voidTransaction]( /docs/void-transactions) method. Please see the description of the [voidTransaction]( /docs/void-transactions) method for more details on how to determine which of these methods is most appropriate. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [TransactionResponse](/docs/transactionresponse) **runCheckCredit** ( [ueSecurityToken](/docs/uesecuritytoken) Token, [TransactionRequestObject](/docs/transactionrequestobject) Params ) [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": "[TransactionRequestObject](/docs/transactionrequestobject)", "1-1": "Params", "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.99',\n 'Invoice' => '44539'\n ),\n 'CheckData' => array(\n 'CheckNumber' => '1234',\n 'Routing' => '123456789',\n 'Account' => '11111111',\n 'AccountType' => 'Savings',\n 'DriversLicense' => '34521343',\n 'DriversLicenseState' => 'CA',\n 'RecordType' => 'PPD'\n )\n );\n $res=$client->runCheckCredit($token, $Request);\n} \ncatch (SoapFault $e) {\n echo $client->__getLastRequest();\n echo $client->__getLastResponse();\n die(\"runCheckCredit failed :\" .$e->getMessage());\n }\n?>", "language": "php" } ] } [/block] ## Java [block:code] { "codes": [ { "code": "try {\n TransactionRequestObject params = new TransactionRequestObject();\n //set account holder name\n params.setAccountHolder(\"Test Joe\");\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 CheckData checkdata = new CheckData();\n checkdata.setRouting(\"123123123\");\n checkdata.setAccount(\"321321\");\n params.setCheckData(checkdata);\n // Create request object\n RunCheckCredit request = new RunCheckCredit();\n request.setToken(token);\n request.setParams(params);\n // Create response object\n TransactionResponse response;\n // run credit\n response = client.runCheckCredit(token, params);\n System.out.println(\"Response: \" + response.getResult() + \" RefNum: \" + response.getRefNum());\n} catch (Exception e) {\n System.out.println(\"Soap Exception: \" + e.getMessage());\n}\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 transaction As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\n transaction.CheckData = New eBizCharge.CheckData\n transaction.CheckData.Account = \"1112223333\"\n transaction.CheckData.Routing = \"123456789\"\n transaction.CheckData.DriversLicense = \"D5555555\"\n transaction.CheckData.DriversLicenseState = \"CA\"\n transaction.Details = New eBizCharge.TransactionDetail\n transaction.Details.Amount = \"1.00\"\n transaction.Details.AmountSpecified = True\n transaction.Details.Invoice = \"55555\"\n transaction.Details.Description = \"Test Check Sale\"\n transaction.AccountHolder = \"Test Guy\"\n Dim response As eBizCharge.TransactionResponse\n response = client.runCheckCredit(token, transaction)\n If response.ResultCode = \"A\" Then\n MsgBox(\"Transaction Approved, Reference 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": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();\n tran.Details = new eBizCharge.TransactionDetail();\n tran.Details.Amount = 1.00;\n tran.Details.AmountSpecified = true;\n tran.Details.Invoice = \"1234\";\n tran.Details.Description = \"Sample Check Credit\";\n tran.CheckData = new eBizCharge.CheckData();\n tran.CheckData.Account = \"1112223333\";\n tran.CheckData.Routing = \"123456789\";\n tran.CheckData.DriversLicense = \"D5555555\";\n tran.CheckData.DriversLicenseState = \"CA\";\n tran.AccountHolder = \"Test Guy\";\n eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\n try\n {\n response = client.runCheckCredit(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/\" xmlns:ns1=\"urn:eBizCharge\"\nxmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns: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:runCheckCredit>\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<Params xsi:type=\"ns1:TransactionRequestObject\">\n <AccountHolder xsi:type=\"xsd:string\">Tester Jones 111</AccountHolder>\n <CheckData xsi:type=\"ns1:CheckData\">\n <Account xsi:type=\"xsd:string\">11111111</Account>\n <AccountType xsi:type=\"xsd:string\">Savings</AccountType>\n <CheckNumber xsi:type=\"xsd:integer\">1234</CheckNumber>\n <DriversLicense xsi:type=\"xsd:string\">34521343</DriversLicense>\n <DriversLicenseState xsi:type=\"xsd:string\">CA</DriversLicenseState>\n <RecordType xsi:type=\"xsd:string\">PPD</RecordType>\n <Routing xsi:type=\"xsd:string\">123456789</Routing>\n </CheckData>\n <Details xsi:type=\"ns1:TransactionDetail\">\n <Amount xsi:type=\"xsd:double\">4.99</Amount>\n <Description xsi:type=\"xsd:string\">Example Credit</Description>\n <Invoice xsi:type=\"xsd:string\">44539</Invoice>\n </Details>\n</Params>\n</ns1:runCheckCredit>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]