Integrating the Risk Inquiry Service .NET SDK

To install the latest Risk Inquiry Service .NET SDK, we recommend using the NuGet package manager. Enter the following command in the NuGet console:

nuget install Kount.Net.RisSDK

For information on how to build the Risk Inquiry Service .NET SDK from the GitHub SDK repository, refer to the Building the RIS .NET SDK from the GitHub repository.

Before you make your first Risk Inquiry Service call, you must have the following:

In your app or web configuration file, in the appsettings.json section, add your basic configuration. Before using the SDK, you must set the Merchant ID and RIS URL to the config file.

{
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "ConnectionStrings": {
    "Ris.MerchantId": "900100",
    "Ris.API.Key": "INSERT_API_KEY",
    "Ris.Config.Key": "INSERT_CONFIG_KEY",
    "Ris.Url": "https://risk.test.kount.net",
    "Ris.Version": "0720",
    "Ris.CertificateFile": "certificate.pfx",
    "Ris.PrivateKeyPassword": "11111111111111111",
    "Ris.Connect.Timeout": "10000",
    "LOG.LOGGER": "SIMPLE",
    "LOG.SIMPLE.LEVEL": "DEBUG",
    "LOG.SIMPLE.ELAPSED": "ON"
  }
}

<Project Sdk="Microsoft.NET.Sdk">

 <PropertyGroup>
   <OutputType>Exe</OutputType>
   <TargetFramework>net7.0</TargetFramework>
   <ImplicitUsings>enable</ImplicitUsings>
   <Nullable>enable</Nullable>
 </PropertyGroup>

 <ItemGroup>
   <PackageReference Include="Microsoft.Extensions.Logging.Abstractions"
Version="6.0.0" />
   <PackageReference Include="Microsoft.Extensions.Configuration"
Version="6.0.0" />
   <PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions"
Version="6.0.0" />
   <PackageReference Include="Microsoft.Extensions.Configuration.Json"
Version="6.0.0" />
   <PackageReference Include="System.Configuration.ConfigurationManager"
Version="6.0.0" />
   <Reference Include="KountRisSdk">
    <HintPath>..\Kount.Net.RisSDK.8.1.0\lib\netstandard2.0\KountRisSdk.dll</
HintPath>
    </Reference>
   </ItemGroup>
</Project>

The following table describes the required static settings found in the SDK:

After a merchant has posted Risk Inquiry Service information to Kount, a key-value pair string is returned to the merchant. The RIS response format is the same that was specified in the Risk Inquiry Service request, with the default being named pairs. Each data field must be invoked by getter methods on the response object from the SDK. The merchant can then use the Risk Inquiry Service response to automate the order management process by keying off of the AUTO field and can utilize any of the additional data returned for internal processing.

An important use of the Risk Inquiry Service response is the ability to view any warnings or errors that were made during the Risk Inquiry Service post from the merchant. All warnings are displayed in the response and if errors do occur the Risk Inquiry Service response will be returned with a MODE = E.

If the Device Data Collector was used to collect customer information, the KAPT field can be checked to determine if this process was successful. KAPT = Y means successful, KAPT = N means the process was unsuccessful.

When using the SDK, KHASH and MASK are available.

Output : BIN + 14 alpha-numeric characters.
Example: "123456A12C34E56G7DFG"

/// <summary>
/// Create inquiry with CARD payment
/// </summary>
/// <param name="cardNumber">card number</param>
/// <param name="sid">session id</param>
/// <param name="orderNum">order number</param>
/// <returns>inquiry</returns>
public static Inquiry CreateInquiry(string cardNumber, out string sid, out string orderNum)
{
// create inquiry with default settings
Inquiry inquiry = DefaultInquiry(out sid, out orderNum);
// hashing card number
inquiry.SetCardPayment(cardNumber);

return inquiry;
}

/// <summary>
/// Create masked inquiry with CARD payment
/// </summary>
/// <param name="cardNumber">card number</param>
/// <param name="sid">session id</param>
/// <param name="orderNum">order number</param>
/// <returns>masked inquiry</returns>
public static Inquiry CreateInquiryMasked(string cardNumber, out string sid, out string orderNum)
{
// create inquiry with default settings
Inquiry inquiry = DefaultInquiry(out sid, out orderNum);
// mask card number
inquiry.SetCardPaymentMasked(cardNumber);

return inquiry;
}

The two major request types, Inquiry and Update, are configured by setting the MODE parameter to the correct value.

Use Inquiry for initial registration of the purchase in the Kount system. It has four available values for the MODE parameter:

Use Update whenever there are changes to a given order that need to be updated in the Kount system. Update has two available values for the MODE parameter:

The Kount Risk Inquiry Service .NET SDK includes a basic logging framework abstraction. This allows your logging framework to be integrated with the SDK. By default, the SDK provides two basic loggers: NOP and SIMPLE.

NOP is a logger that silently discards all logging. This is the default logger used by the .NET RIS SDK. SIMPLE is a logger that logs messages to a specified file on the SDK host-machine.

SIMPLE logger can be configured in your App.config. The following logging levels are available in order of decreasing severity: FATAL, ERROR, WARN, INFO, and DEBUG.

Kount recommends the following steps to integrate a custom logger with the SDK.

/// <summary>
/// A class demonstrating how to use logging
/// </summary>
public class ExampleClient
{
/// <summary>
/// The main entry point for the application.<br/>
/// <b>Author:</b> Kount <a>custserv@kount.com</a>;<br/>
/// <b>Version:</b> 6.5.0. <br/>
/// <b>Copyright:</b> 2010 Keynetics Inc <br/>
/// </summary>
[STAThread]
public static void Main()
{
ILoggerFactory factory = LogFactory.GetLoggerFactory();
ILogger logger = factory.GetLogger("Example Client");
logger.Debug("Hello World");
logger.Info("Hello World");
logger.Warn("Hello World");
logger.Error("Hello World");
logger.Fatal("Hello World");

// How to log messages and exceptions.
try
{
Exception e = new Exception("Logging an exception");
throw e;
}
catch (Exception e)
{
logger.Debug("Hello World", e);
logger.Info("Hello World", e);
logger.Warn("Hello World", e);
logger.Error("Hello World", e);
logger.Fatal("Hello World", e);
}
}
}

using var loggerFactory = LoggerFactory.Create(builder =>
{
builder.
SetMinimumLevel(LogLevel.Error)
.AddConsole().AddFile("C:/Logs/logfilename.txt");
});
ILogger logger = loggerFactory.CreateLogger<Program>();
// Passing ILogger reference to Kount.Ris.Inquiry
Inquiry inquryObj = new Inquiry(logger);

Kount recommends using the Package Manager. Only build the RIS .NET SDK if required for your environment.

There are two integration test modules in the folder structure: pre-configuration (KountRisTest) and post-configuration (KountRisConfigTest).

Option 1: Pre-Configuration

Option 2: Post-Configuration

Open KountSdk.sln in Visual Studio and build KountSdk.sln.

Where can I find User Defined Fields? Refer to How to Manage User Defined Fields (UDFs). Where can I find accepted payment types and corresponding codes? Refer to Accepted Payment Types and Corresponding Codes. Where can I find RIS error codes? Refer to RIS Error Codes. What are the other RIS modes? Refer to Risk Inquiry Service Modes.