{"_id":"5632a5e849e16d0d0012246f","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,"githubsync":"","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","project":"55b933b3146ef121002158d3","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T17:52:24.918Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":15,"body":"Retrieve the current status of a specific transaction.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method allows you to check the status of a completed transaction.\nUse this method to determine if a transaction has been authorized, processed, or settled.\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\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[TransactionResponse](/docs/transactionresponse) **getTransactionStatus** ( [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\": \"ReturnValue\"\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 $refnum='1005312';\\n print_r($client->getTransactionStatus($token,$refnum));\\n }\\ncatch(SoapFault $e) {\\n echo $e->getMessage();\\n}\\necho \\\"\\\\n\\\\nRequest: \\\" . $tran->__getLastRequest();\\necho \\\"\\\\n\\\\nResponse: \\\" . $tran->__getLastResponse();\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Java \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"try {\\n //Set RefNum to the Reference Number of transaction you\\n //want to retrieve.\\n BigInteger refnum = new BigInteger();\\n TransactionResponse response = new TransactionResponse();\\n response = client.getTransactionStatus(token, refnum);\\n System.out.println(response.getStatus());\\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(\\\"982lz9VsLm87MA54Sv8E582h8OZMArL6\\\", \\\"443311\\\")\\n   Dim transaction As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\\n   Dim refnum As Integer\\n   refnum = \\\"46405618\\\"\\n   Dim response As eBizCharge.TransactionResponse = New eBizCharge.TransactionResponse\\n   response = client.getTransactionStatus(token, refnum)\\n   If response.StatusCode = \\\"P\\\" Then\\n     MsgBox(\\\"Status: Pending\\\")\\n   ElseIf response.StatusCode = \\\"B\\\" Then\\n     MsgBox(\\\"Status: Submitted\\\")\\n   ElseIf response.StatusCode = \\\"E\\\" Then\\n     MsgBox(\\\"Status: Error, Reason: \\\" & response.Error)\\n   ElseIf response.StatusCode = \\\"N\\\" Then\\n     MsgBox(\\\"Status: New Transaction\\\")\\n   ElseIf response.StatusCode = \\\"F\\\" Then\\n     MsgBox(\\\"Status: Funded\\\")\\n   ElseIf response.StatusCode = \\\"S\\\" Then\\n     MsgBox(\\\"Status: Settled\\\")\\n   ElseIf response.StatusCode = \\\"V\\\" Then\\n     MsgBox(\\\"Status: Voided\\\")\\n   ElseIf response.StatusCode = \\\"T\\\" Then\\n     MsgBox(\\\"Status: Timed Out (no response in 5 days)\\\")\\n   ElseIf response.StatusCode = \\\"R\\\" Then\\n     MsgBox(\\\"Status: Returned\\\")\\n   ElseIf response.StatusCode = \\\"M\\\" Then\\n     MsgBox(\\\"Status: On Hold\\\")\\n   End If\\n\",\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 = \\\"46973526\\\";\\n           eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\\n           try\\n           {\\n               response = client.getTransactionStatus(token, refnum);\\n               if (response.StatusCode == \\\"V\\\") { MessageBox.Show(string.Concat(\\\"Status: Voided\\\")); }\\n               if (response.StatusCode == \\\"B\\\") {MessageBox.Show(string.Concat(\\\"Status: Submitted\\\"));}\\n               if (response.StatusCode == \\\"E\\\") {MessageBox.Show(string.Concat(\\\"Status: Error, Reason: \\\" + response.Error));}\\n               if (response.StatusCode == \\\"N\\\") {MessageBox.Show(string.Concat(\\\"Status: New transaction\\\"));}\\n               if (response.StatusCode == \\\"F\\\") {MessageBox.Show(string.Concat(\\\"Status: Funded\\\"));}\\n               if (response.StatusCode == \\\"S\\\") {MessageBox.Show(string.Concat(\\\"Status: Settled\\\"));}\\n               if (response.StatusCode == \\\"P\\\") {MessageBox.Show(string.Concat(\\\"Status: Pending\\\"));}\\n               if (response.StatusCode == \\\"T\\\") {MessageBox.Show(string.Concat(\\\"Status: Timed Out (no response in 5 days)\\\"));}\\n               if (response.StatusCode == \\\"R\\\") {MessageBox.Show(string.Concat(\\\"Status: Returned\\\"));}\\n               if (response.StatusCode == \\\"M\\\") { MessageBox.Show(string.Concat(\\\"Status: On hold\\\")); }\\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:getTransactionStatus>\\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\\\">e4a3cef16854af8c6495a4394050ed4c64af97ed</HashValue>\\n<Seed xsi:type=\\\"xsd:string\\\">1193689131266474060</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\\\">1118418</RefNum>\\n</ns1:getTransactionStatus>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"gettransactionstatus","type":"basic","title":"getTransactionStatus"}

getTransactionStatus


Retrieve the current status of a specific transaction. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method allows you to check the status of a completed transaction. Use this method to determine if a transaction has been authorized, processed, or settled. 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] [TransactionResponse](/docs/transactionresponse) **getTransactionStatus** ( [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": "ReturnValue" } [/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 $refnum='1005312';\n print_r($client->getTransactionStatus($token,$refnum));\n }\ncatch(SoapFault $e) {\n echo $e->getMessage();\n}\necho \"\\n\\nRequest: \" . $tran->__getLastRequest();\necho \"\\n\\nResponse: \" . $tran->__getLastResponse();\n?>", "language": "php" } ] } [/block] ## Java [block:code] { "codes": [ { "code": "try {\n //Set RefNum to the Reference Number of transaction you\n //want to retrieve.\n BigInteger refnum = new BigInteger();\n TransactionResponse response = new TransactionResponse();\n response = client.getTransactionStatus(token, refnum);\n System.out.println(response.getStatus());\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(\"982lz9VsLm87MA54Sv8E582h8OZMArL6\", \"443311\")\n Dim transaction As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject\n Dim refnum As Integer\n refnum = \"46405618\"\n Dim response As eBizCharge.TransactionResponse = New eBizCharge.TransactionResponse\n response = client.getTransactionStatus(token, refnum)\n If response.StatusCode = \"P\" Then\n MsgBox(\"Status: Pending\")\n ElseIf response.StatusCode = \"B\" Then\n MsgBox(\"Status: Submitted\")\n ElseIf response.StatusCode = \"E\" Then\n MsgBox(\"Status: Error, Reason: \" & response.Error)\n ElseIf response.StatusCode = \"N\" Then\n MsgBox(\"Status: New Transaction\")\n ElseIf response.StatusCode = \"F\" Then\n MsgBox(\"Status: Funded\")\n ElseIf response.StatusCode = \"S\" Then\n MsgBox(\"Status: Settled\")\n ElseIf response.StatusCode = \"V\" Then\n MsgBox(\"Status: Voided\")\n ElseIf response.StatusCode = \"T\" Then\n MsgBox(\"Status: Timed Out (no response in 5 days)\")\n ElseIf response.StatusCode = \"R\" Then\n MsgBox(\"Status: Returned\")\n ElseIf response.StatusCode = \"M\" Then\n MsgBox(\"Status: On Hold\")\n End If\n", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string refnum;\n refnum = \"46973526\";\n eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();\n try\n {\n response = client.getTransactionStatus(token, refnum);\n if (response.StatusCode == \"V\") { MessageBox.Show(string.Concat(\"Status: Voided\")); }\n if (response.StatusCode == \"B\") {MessageBox.Show(string.Concat(\"Status: Submitted\"));}\n if (response.StatusCode == \"E\") {MessageBox.Show(string.Concat(\"Status: Error, Reason: \" + response.Error));}\n if (response.StatusCode == \"N\") {MessageBox.Show(string.Concat(\"Status: New transaction\"));}\n if (response.StatusCode == \"F\") {MessageBox.Show(string.Concat(\"Status: Funded\"));}\n if (response.StatusCode == \"S\") {MessageBox.Show(string.Concat(\"Status: Settled\"));}\n if (response.StatusCode == \"P\") {MessageBox.Show(string.Concat(\"Status: Pending\"));}\n if (response.StatusCode == \"T\") {MessageBox.Show(string.Concat(\"Status: Timed Out (no response in 5 days)\"));}\n if (response.StatusCode == \"R\") {MessageBox.Show(string.Concat(\"Status: Returned\"));}\n if (response.StatusCode == \"M\") { MessageBox.Show(string.Concat(\"Status: On hold\")); }\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:getTransactionStatus>\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\">e4a3cef16854af8c6495a4394050ed4c64af97ed</HashValue>\n<Seed xsi:type=\"xsd:string\">1193689131266474060</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\">1118418</RefNum>\n</ns1:getTransactionStatus>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]