Developer Resources
GetSessionTags
GetSessionTags returns the WebSessionID and OrgID needed for client-side forensics and fraud detection.
Request Parameters
Use the following request parameters when integrating to GetSessionTags:
AccountName (Required)Data Type: String
Field Dependence: Required
Sensitive: No
Description: API username.
Maximum Length: 32
Password (Required)Data Type: String
Field Dependence: Required
Sensitive: Yes
Description: API password.
Maximum Length: 64
TransactionID (Required)Data Type: String
Field Dependence: Required
Sensitive: No
Description: The unique identification number used to track the transaction.
Maximum Length: 36
Response Parameters
GetSessionTags returns the following response parameters:
OrgIDData Type: String
Field Dependence: Required
Sensitive: No
Description: Returns the organization identification number needed for the device fingerprinting JavaScript.
Maximum Length: 32
ResponseCodeData Type: Integer
Sensitive: No
Description: Returns a 0 for success or a non-zero code for failure to process the API. See Response Codes for the possible non-zero code returned by the GetSessionTags API.
Maximum Length: N/A
ResponseTextData Type: String
Sensitive: No
Description: Returns a description for non-zero Response Codes.
Maximum Length: 1024
WebSessionIDData Type: String
Sensitive: No
Description: Returns the identification number assigned to the session that is needed for the device fingerprinting JavaScript.
Maximum Length: 128
Response Codes
Each API call returns a numeric response code. If the response code is zero, the API transaction completed successfully without errors; however, the status of the transaction may not be complete. If the response code is non-zero, an error message is included with the response code.
Note: When non-zero response codes are returned, the response fields might not be returned correctly. Review the error messages associated with non-zero response codes and take appropriate steps to resolve the error conditions. Most of the non-zero response codes indicate a system configuration or integration issue. Before production deployment, you should resolve these issues during the testing phase.
0 Success.Suggested Customer Message: Transaction completed.
Note: Not an error condition.
1 General system failure.Suggested Customer Message: System not available. Please try again later.
Note: A low-level error message that may indicate a communication problem, a timing problem, an intermittent failure to contact an acquirer, or another condition not captured by the other response codes. If this response code is returned after repeated attempts, contact Support.
510 Parameter [name] is required.Note: No value was sent for a required parameter. Check all required parameters are included in the API call.
511 Parameter [name] exceeds max length of [value].Note: A required parameter contains too many characters. Check the length does not exceed the maximum length value specified for the parameter.
1001 Login failed.Suggested Customer Message: System not available. Please try again later.
Note: Authentication failed. Check your credentials and try again, or contact Support.
1005 Account not active.Suggested Customer Message: System not available. Please try again later.
Note: Indicates a problem with the merchant's account. Contact Support.
1006 API {GetSessionTags} is not available.Note: API {GetSessionTags} is not available.