getTransactionProfile

Retrieve fraud profiling data for a transaction.

Description

This method retrieves the fraud profiling data for a given transaction.

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.

If profiling data is available, a TransactionProfile object is returned. This object contains profile data such as the scoring and extended device data.

See also getSession, ThreatMetrix Guide

Syntax

TransactionProfile getTransactionProfile ( ueSecurityToken Token, string RefNum)

Arguments

Type	Name	Description
ueSecurityToken	Token	Merchant security token: used to identify merchant and validate transaction.
string	RefNum	Unique transaction reference number assigned by the gateway. You can also use TransKey in the RefNum field.

Return Value

Type	Description
TransactionProfile	Returns fraud profile data.

Exceptions

The following exceptions (errors) are applicable to this method.

Code	Message	Advice
20001	Specified transactions was not found	RefNum didn't match any of the merchants transactions.
20035	Merchant does not have fraud profiling enabled	The merchant's account must be configured for fraud profiling. They should contact their reseller to sign up for the service.

Examples

PHP

For directions on how to set up the WSDL link, create "$token" and "$client", go to PHP Soap How-to.

    <?php

    try {
      $RefNum='12345678';
      $data=$client->getTransactionProfile($token, $RefNum);  
      print_r($data);              
    }

    catch (SoapFault $e) {
      die("Call failed :" .$e->getMessage());
      }

    ?>

.NET VB

    Dim response As newtek.TransactionProfile

    response = client.getTransactionProfile(token, 1234567)

    MsgBox("DeviceID: " & response.DeviceID);

.NET C

    newtek.TransactionProfile response;

    try
        {
           response = client.getTransactionProfile(token);

           MessageBox.Show(response.DeviceID);

        }
        catch (Exception err)
        {
            MessageBox.Show(err.Message);
        }

Change Log

Version	Change
1.7	TransKey can be used in RefNum field.