Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
note
Note

IMPORTANT: The Kount Command plugin differs from our legacy Kount plugin in that it supports all payment gateways EXCEPT Authorize.net, while the earlier Kount plugin was limited to only Authorize.net and Braintree users. Both plugins CANNOT be installed simultaneously or checkout will fail.

WARNING: Once installed, the Kount Command plugin must be set up with API credentials. If the plugin is installed and the credentials are not added, checkout will be blocked on order complete.

Setup Checklist

Insert excerpt
Set-up Checklist
Set-up Checklist
nopaneltrue

1. KOUNT TASKS

  • Ensure that working agreement with Kount is finalized.

    Status
    colourRed
    titleRequired

  • Obtain API Key from Kount Portal

    Status
    colourRed
    titlerequired

Status
colourYellow
titlePrerequisite

2. COMMERCE TASKS

  1. Install the Kount Command Plugin.

    Status
    colourRed
    titlerequired

  2. Restart the site.

    Status
    colourRed
    titlerequired

Obtain API Key from Kount Portal
  1. Enable the Plugin.

    Status
    colourRed
    titlerequired

  2. Configure the Kount Command Test environment.

    Status
    colourRed
    titlerequired

  3. Work with your Kount Representative to create Kount rules.

    Status
    colourRed
    titlerequired

  4. Verify transactions are working as expected.

    Status
    colourRed
    titlerequired

  5. Configure the Kount Command Production environment.

    Status
    colourRed
    titlerequired

Status
colourGreen
titleDetailed Setup

Prerequisite Tasks

Insert excerpt
Prerequisites Tasks Excerpt
Prerequisites Tasks Excerpt
nopaneltrue

...

  • Ensure that you have a working agreement with Kount and that you have access to your Kount Dashboard/Administration screen.

  • Obtain API Key from Kount Portal.

    • Log in to Kount Portal through  https://awc.test.kount.net using credentials provided by Kount.

      1. Click ADMIN and select API Keys.

        Image Added

      2. Option 1: You may copy an existing API key and paste it into the configuration panel below.

        1. IMPORTANT: If you copy and paste the key, best practices suggest you copy, paste the key into a text editor, and inspect it for any additional characters, leading spaces, etc.  Remove any extra characters. Once verified, copy from the text editor and paste it into the configuration pane.

          Image Added
      3. Option 2: Generate a new API Key by clicking Create API Key.

        1. IMPORTANT: If you generate a new API key you do not need to revoke it. You can use multiple keys simultaneously. Please follow the instructions above for copying and pasting the newly generated API Key.

          Image Added

      4. Make note of the API Key for use below in Detailed Setup Step #4.

Settings, Language Strings and/or HTML Widgets for this Feature

...

  • These settings can be set by going to Settings > All settings, but using the UI described below in the Detailed Setup Guide is the recommended method.

Setting

Value

kountcommandsettings.apikey

Find your unique API key in your Kount login admin.

kountcommandsettings.devicedatacollectorendpoint

https://tst.kaptcha.com (TEST environment)

https://ssl.kaptcha.com (PROD environment)

kountcommandsettings.riskinquiryserviceendpoint 

https://risk.test.kount.net (TEST environment)

https://risk.kount.net (PROD environment)

kountcommandsettings.merchantid

Find your unique merchant id in your Kount login admin.

kountcommandsettings.siteid

DEFAULT

kountcommandsettings.connectiontimeout

60000

Language String

Value

aspenware.kountcommand.messages.failedvalidation

[This text is the message guests see during checkout when they are blocked by Kount.]

Detailed Setup Guide

  1. Install the Kount Command Plugin.

  2. Obtain API Key from Kount Portal.

  3. Configure the Kount Command Test environment.

  4. Work with your Kount Representative to create Kount rules.

  5. Verify transactions are working as expected.

  6. Configure the Kount Command Production environment.

Note

WARNINGIMPORTANT: Once installed, the Kount Command plugin must be enabled and set up with API credentials. If the plugin is installed and the credentials are not added, but not enabled, checkout will be blocked on order complete.  Once enabled the Kount credentials must be populated in order to complete checkout.

1. Install the KountCommand Plugin

  • Go to Configuration > Local plugins.

  • Scroll down to the KountCommand plugin.

  • Click Install.

  • Make sure the plugin is both installed and enabled.

  • If it is not enabled, click Edit and check Is enabled? and click Save.

    Image Removed

...

2. Restart the site.

Once the Kount Command plugin is installed the site must be

...

  • Obtain and make note of your API Key.

    1. Log in to Kount Portal through  https://awc.test.kount.net using credentials provided by Kount.

    2. Click ADMIN and select API Keys.

      Image Removed

    3. Option 1: You may copy an existing API key and paste it into the configuration panel below.

      1. IMPORTANT: If you copy and paste the key, best practices suggest you copy, paste the key into a text editor, and inspect it for any additional characters, leading spaces, etc.  Remove any extra characters. Once verified, copy from the text editor and paste it into the configuration pane.

        Image Removed
    4. Option 2: Generate a new API Key by clicking Create API Key.

      1. IMPORTANT: If you generate a new API key you do not need to revoke it. You can use multiple keys simultaneously. Please follow the instructions above for copying and pasting the newly generated API Key.

        Image Removed

    5. Make note of the API Key for use below.

...

restarted.

3. Enable the Kount Command Plugin

Once the plugin has been installed and the site has been restarted, the plugin needs to be enabled.

  • Go to Configuration > Local plugins.

  • Scroll down to the KountCommand plugin.

  • To enable, click Edit and check Is enabled? and click Save.

    Image Added

...

Note

IMPORTANT: If the plugin has been installed, but is not enabled, checkout will not work. If you are not going to enable the plugin right away, then you must uninstall it and restart the site to prevent checkout from failing.

4. Configure the Kount Command TEST Environment

  • Click Configure to get to the Configure - KountCommand Plugin screen.

  • Enter data into the following fields:

    1. Multi-store configuration: Select the appropriate choice if you have a multi-store configuration.

    2. Use Sandbox?: Check for TEST environment.

    3. API key: Enter the API Key obtained in the

    previous
    1. prerequisite step above.

    2. Device Data Collector Endpoint: https://tst.kaptcha.com

    3. Risk Inquiry Service Endpoint: https://risk.test.kount.net

    4. Merchant ID: Obtain your unique merchant ID from Kount. This is always a 6-digit number.

    5. Site ID: Enter the Website ID defined in Kount. You can find this in the Kount Agent Web Console (Under Fraud Control > Websites). The default name for Site ID is DEFAULT, however can be updated if you use Kount for various sites or resorts.

    6. Connection Timeout: Set to

    60000
    1. 6000

    2. Failed Kount Validation Message: Enter the text that will be displayed to the user if Kount declines the transaction. (See NOTE below.)

      Image Modified
    3. Click Save.

Info

NOTE: For the Failed Kount Validation Message, Kount cautions against providing any information that would assist bad actors in fraudulent activities. One way to provide an excellent customer experience, but not unintentionally support fraudsters, would be to create a unique identifier that would signify to your resort staff that the transaction in question had been declined by Kount, rather than the payment gateway.

For example, you could customize your message to be “We had a problem processing your payment. Error Code: KT 65. Please call us at 800-123-4567 for assistance.”

Then, when call center staff hears the “Code KT 65”, they know that the decline was triggered by Kount, and that this is a potentially fraudulent transaction, rather than a card being declined by the gateway for any number of reasons.

...

5. Work with Kount Representative to Create Kount Rules

Contact your Kount Representative to establish your resort’s Kount strategy and to obtain assistance in establishing Kount rules so that declines process are processed as expected.

  • Log into your Kount Portal.

  • Create a user-defined field (UDF) called STARTDATE ( all caps, all one word). This will allow the earliest Start Date on any product in the transaction to be displayed, and can be used in setting rules for declines.

    • Click Add UDF and enter the following:

      • Label: STARTDATE

      • Description: STARTDATE

      • Type: Select Date

    • Click Save UDF.

  • Ensure that all Kount rules have been defined per your resort’s Kount strategy. Rules need to be included in a ruleset, and the ruleset must be activated for the rules to apply to transactions.

...

...

6. Verify Transactions

Log into your Kount Portal and verify that you can see transactions in Kount. Test to ensure that transactions are processing correctly and that declines are occurring as expected per the defined ruleset.

...

...

7. Configure the Kount Command Production Environment

Once you have established that Kount is functioning properly, you may create your PROD environment.

  • Click Configure to get to the Configure - KountCommand Plugin screen.

  • Enter data into the following fields:

    1. Multi-store configuration: Select the appropriate choice if you have a multi-store configuration.

    2. Use Sandbox?: Uncheck for PROD environment.

    3. API key: Obtain a new API Key as you did for TEST (Step 2 above) by logging into https://portal.kount.net. This CANNOT be the same API Key that was used for your TEST environment.

    4. Device Data Collector Endpoint: https://ssl.kaptcha.com (for PROD environment)

    5. Risk Inquiry Service Endpoint: https://risk.kount.net (for PROD environment)

    6. Merchant ID: Obtain your unique merchant ID from Kount. This is always a 6-digit number.

    7. Site ID: Enter the Website ID defined in Kount. You can find this in the Kount Agent Web Console (Under Fraud Control > Websites). The default name for Site ID is DEFAULT, however can be updated if you use Kount for various sites or resorts.

    8. Connection Timeout: Set to 60000

    9. Failed Kount Validation Message: Enter the text that will be displayed to the user if Kount declines the transaction. (See NOTE below.)

      Image Modified
    10. Click Save.

Info

NOTE: For the Failed Kount Validation Message, Kount cautions against providing any information that would assist bad actors in fraudulent activities. One way to provide an excellent customer experience, but not unintentionally support fraudsters, would be to create a unique identifier that would signify to your resort staff that the transaction in question had been declined by Kount, rather than the payment gateway.

For example, you could customize your message to be “We had a problem processing your payment. Error Code: KT 65. Please call us at 800-123-4567 for assistance.”

Then, when call center staff hears the “Code KT 65”, they know that the decline was triggered by Kount, and that this is a potentially fraudulent transaction, rather than a card being declined by the gateway for any number of reasons.

...

...