{"_id":"5632a5e849e16d0d00122471","user":"55b932ba8fd1a02b00f496c8","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"},"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":"","project":"55b933b3146ef121002158d3","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T17:52:58.115Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":17,"body":"Retrieve the current status and tracking data for a specific electronic check transaction.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method allows you to check the status and tracking data on an electronic check transaction.\nUse this method to determine what state a check transaction is in.\nTo specify the transaction you would like to view, you must retrieve it using the reference number (RefNum) assigned to the transaction by the gateway. The RefNum is assigned by the gateway and returned when a transaction is processed. To find a missing RefNum, use the [searchTransactions](/docs/searchtransactions) method.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[CheckTrace](/docs/checktrace) **getCheckTrace** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer RefNum )\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\": \"RefNum\",\n    \"1-2\": \"Transaction 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 a CheckTrace object containing the check specific status and tracking information\",\n    \"0-0\": \"[CheckTrace](/docs/checktrace)\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exceptions\"\n}\n[/block]\nThe following exceptions (errors) are applicable to this method.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Message\",\n    \"h-2\": \"Advice\",\n    \"0-0\": \"20001\",\n    \"0-1\": \"Specified transactions was not found.\",\n    \"0-2\": \"RefNum provided was not found by the system. Make sure the RefNum was not truncated and belongs to this merchant (identified by Token) on this server (Sandbox RefNum cannot be looked up in production and vice versa).\",\n    \"1-0\": \"40201\",\n    \"1-1\": \"Incorrect transaction type\",\n    \"1-2\": \"getCheckTrace will only work for electronic check transactions. This exception will be thrown if RefNum refers to a credit card transaction\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\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 $RefNum=1119999999;\\n $res = $client->getCheckTrace($token, $RefNum);\\n print_r($res);\\n}\\ncatch(SoapFault $e) {\\n echo $e->getMessage();\\n}\\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 refnum As Integer\\n       refnum = 46999316\\n       Dim trace As eBizCharge.CheckTrace = New eBizCharge.CheckTrace\\n       trace = client.getCheckTrace(token, refnum)\\n       MsgBox(\\\"Tracking Number: \\\" & trace.TrackingNum)\\t\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string refnum;\\n           refnum = \\\"46973419\\\";\\n           eBizCharge.CheckTrace trace = new eBizCharge.CheckTrace();\\n           try\\n           {\\n               trace = client.getCheckTrace(token,refnum);\\n               MessageBox.Show(string.Concat(trace.TrackingNum));\\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\": \"Request:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\n xmlns:ns1=\\\"urn:eBizCharge\\\" xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\n xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\n xmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\n SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:getCheckTrace>\\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 <RefNum xsi:type=\\\"xsd:integer\\\">1330908</RefNum>\\n</ns1:getCheckTrace>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\\nResponse:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope\\n xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\n xmlns:ns1=\\\"urn:eBizCharge\\\"\\n xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\n xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\n xmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\n SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:getCheckTraceResponse>\\n <getCheckTraceReturn xsi:type=\\\"ns1:CheckTrace\\\">\\n   <Status xsi:type=\\\"xsd:string\\\">Returned</Status>\\n   <StatusCode xsi:type=\\\"xsd:string\\\">R</StatusCode>\\n   <BankNote xsi:type=\\\"xsd:string\\\">Example Note</BankNote>\\n   <Effective xsi:type=\\\"xsd:string\\\">2009-08-11</Effective>\\n   <Processed xsi:type=\\\"xsd:string\\\">2009-08-09</Processed>\\n   <Returned xsi:type=\\\"xsd:string\\\">2009-08-09</Returned>\\n   <ReturnCode xsi:type=\\\"xsd:string\\\">R01</ReturnCode>\\n   <Reason xsi:type=\\\"xsd:string\\\">Insufficent Funds</Reason>\\n   <Settled xsi:type=\\\"xsd:string\\\">2009-08-09</Settled>\\n   <TrackingNum xsi:type=\\\"xsd:string\\\">09080949883506</TrackingNum>\\n </getCheckTraceReturn>\\n</ns1:getCheckTraceResponse>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getchecktrace","type":"basic","title":"getCheckTrace"}
Retrieve the current status and tracking data for a specific electronic check transaction. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method allows you to check the status and tracking data on an electronic check transaction. Use this method to determine what state a check transaction is in. To specify the transaction you would like to view, you must retrieve it using the reference number (RefNum) assigned to the transaction by the gateway. The RefNum is assigned by the gateway and returned when a transaction is processed. To find a missing RefNum, use the [searchTransactions](/docs/searchtransactions) method. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [CheckTrace](/docs/checktrace) **getCheckTrace** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer RefNum ) [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": "RefNum", "1-2": "Transaction 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 a CheckTrace object containing the check specific status and tracking information", "0-0": "[CheckTrace](/docs/checktrace)" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Exceptions" } [/block] The following exceptions (errors) are applicable to this method. [block:parameters] { "data": { "h-0": "Code", "h-1": "Message", "h-2": "Advice", "0-0": "20001", "0-1": "Specified transactions was not found.", "0-2": "RefNum provided was not found by the system. Make sure the RefNum was not truncated and belongs to this merchant (identified by Token) on this server (Sandbox RefNum cannot be looked up in production and vice versa).", "1-0": "40201", "1-1": "Incorrect transaction type", "1-2": "getCheckTrace will only work for electronic check transactions. This exception will be thrown if RefNum refers to a credit card transaction" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $RefNum=1119999999;\n $res = $client->getCheckTrace($token, $RefNum);\n print_r($res);\n}\ncatch(SoapFault $e) {\n echo $e->getMessage();\n}\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 refnum As Integer\n refnum = 46999316\n Dim trace As eBizCharge.CheckTrace = New eBizCharge.CheckTrace\n trace = client.getCheckTrace(token, refnum)\n MsgBox(\"Tracking Number: \" & trace.TrackingNum)\t", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string refnum;\n refnum = \"46973419\";\n eBizCharge.CheckTrace trace = new eBizCharge.CheckTrace();\n try\n {\n trace = client.getCheckTrace(token,refnum);\n MessageBox.Show(string.Concat(trace.TrackingNum));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "Request:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\n xmlns:ns1=\"urn:eBizCharge\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\n SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:getCheckTrace>\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 <RefNum xsi:type=\"xsd:integer\">1330908</RefNum>\n</ns1:getCheckTrace>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\nResponse:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope\n xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\n xmlns:ns1=\"urn:eBizCharge\"\n xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\n SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:getCheckTraceResponse>\n <getCheckTraceReturn xsi:type=\"ns1:CheckTrace\">\n <Status xsi:type=\"xsd:string\">Returned</Status>\n <StatusCode xsi:type=\"xsd:string\">R</StatusCode>\n <BankNote xsi:type=\"xsd:string\">Example Note</BankNote>\n <Effective xsi:type=\"xsd:string\">2009-08-11</Effective>\n <Processed xsi:type=\"xsd:string\">2009-08-09</Processed>\n <Returned xsi:type=\"xsd:string\">2009-08-09</Returned>\n <ReturnCode xsi:type=\"xsd:string\">R01</ReturnCode>\n <Reason xsi:type=\"xsd:string\">Insufficent Funds</Reason>\n <Settled xsi:type=\"xsd:string\">2009-08-09</Settled>\n <TrackingNum xsi:type=\"xsd:string\">09080949883506</TrackingNum>\n </getCheckTraceReturn>\n</ns1:getCheckTraceResponse>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]