{"_id":"5632a5e849e16d0d00122477","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,"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","githubsync":"","user":"55b932ba8fd1a02b00f496c8","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T17:57:55.621Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":23,"body":"Generate a session for fraud profiling.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method generates a fraud profiling session. Fraud profiling allows merchants to perform in depth analysis and business risk assessment using third party services such as Threat Metrix. These premium services must be enabled on the merchants account before this method may be used.\nThe method returns a TransactionSession object which contains a session id and an org id. These variables are used to assemble the profiling html snippet that needs to be displayed to the end user. The session id is then passed in with the runTransaction, runSale, etc call.\nSee also [ThreatMetrix Guide](#)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[TransactionSession](/docs/transactionsession) **getSession** ( [ueSecurityToken](/docs/uesecuritytoken) Token)\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  },\n  \"cols\": 3,\n  \"rows\": 1\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-0\": \"[TransactionSession](/docs/transactionsession)\",\n    \"0-1\": \"Returns session data.\"\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\": \"20035\",\n    \"0-1\": \"Merchant does not have fraud profiling enabled\",\n    \"0-2\": \"The merchant's account must be configured for fraud profiling. They should contact their reseller to sign up for the service.\"\n  },\n  \"cols\": 3,\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 $res=$client->getSession($token);  \\n print_r($data);\\n}\\ncatch (SoapFault $e) {\\n die(\\\"Get Session failed :\\\" .$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 response As eBizCharge.TransactionSession\\n       response = client.getSession(token, report, options, format)\\n       Dim binary_data As Byte() = Convert.FromBase64String(response)\\n       MsgBox(\\\"SessionID: \\\" & response.SessionID);\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.TransactionSession response;\\n           try\\n               {\\n                  response = client.getSession(token);\\n                  MessageBox.Show(response.SessionID);\\n               }\\n               catch (Exception err)\\n               {\\n                   MessageBox.Show(err.Message);\\n               }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getsession","type":"basic","title":"getSession"}
Generate a session for fraud profiling. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method generates a fraud profiling session. Fraud profiling allows merchants to perform in depth analysis and business risk assessment using third party services such as Threat Metrix. These premium services must be enabled on the merchants account before this method may be used. The method returns a TransactionSession object which contains a session id and an org id. These variables are used to assemble the profiling html snippet that needs to be displayed to the end user. The session id is then passed in with the runTransaction, runSale, etc call. See also [ThreatMetrix Guide](#) [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [TransactionSession](/docs/transactionsession) **getSession** ( [ueSecurityToken](/docs/uesecuritytoken) Token) [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." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "[TransactionSession](/docs/transactionsession)", "0-1": "Returns session data." }, "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": "20035", "0-1": "Merchant does not have fraud profiling enabled", "0-2": "The merchant's account must be configured for fraud profiling. They should contact their reseller to sign up for the service." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $res=$client->getSession($token); \n print_r($data);\n}\ncatch (SoapFault $e) {\n die(\"Get Session failed :\" .$e->getMessage());\n }\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim response As eBizCharge.TransactionSession\n response = client.getSession(token, report, options, format)\n Dim binary_data As Byte() = Convert.FromBase64String(response)\n MsgBox(\"SessionID: \" & response.SessionID);", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.TransactionSession response;\n try\n {\n response = client.getSession(token);\n MessageBox.Show(response.SessionID);\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block]