Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
Kount

Create Kount Inquiry

post/kount-inquiries

Request body

idempotencyKeystring required

A Unique Identifier that is required for handling idempotent requests.

Note: Moneris encourages the use of UUID Version 4 in APIs as an idempotency key."

orderIdstring nullable

Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transaction

Note: No two transactions of these types may have the same order ID. Field only accepts alphanumerical characters, dashes and underscores.

kountAccountIdstring required

6 digit local identifier used by the merchant to identify the kount inquiry request

kountApiKeystring required

The API key for the associated with the Kount Merchant ID

originatedFromCallCenterboolean required

Refers to Kount's Call center indicator.

Flag indicating whether risk inquiry request originates from a call center environment If the customer service agents navigate to a separate order entry page that does not collect iframe data: When sending the kount_inquiry request, set call_center_ind to Y If the customer service agents navigate to the same order entry page as the customer: When sending the kount_inquiry request, set call_center_ind to N If Risk Inquiry Service call does not originate from a call center environment, set call_center_ind to N

True for YES, False fo NO

sessionIdstring required

Unique Session ID; must be unique over a 30-day span

websiteIdstring required

Website identifier of where order originated

emailstring email required

Contains the customer's email address.

For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322

automaticNumberIdstring nullable

Automatic Number Identification (ANI) submitted with order If the ANI cannot be determined, merchant must pass 0123456789 as the ANID NOTE: This field is only valid for phone-to-web requests where customer service agents navigate to a separate order entry page that does not collect iframe data Risk Inquiry Service submissions

dateOfBirthstring date nullable

Date of Birth.

timestampstring date-time nullable

This is timestamp associated with the creation of a user in Kount service.

gender'MALE' | 'FEMALE' | 'null' nullable

An individual's gender

customerNamestring nullable

Customers full name

financialOrderIdstring nullable

Unique identifier for transactions at Kount

shippingType'SAME_DAY' | 'NEXT_DAY' | 'SECOND_DAY' | 'STANDARD' | 'null' nullable

Shipping type. The following nomenclature is expected for shipping types to be passed to Kount. NOTE:These three attributes can be used to pass custom attribute data if you want to correlate some data with the returned response

ipv4string ipv4 required

Internet Protocol version 4 (IPv4).

customDataCustomData nullable

Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

Example request

{
  "idempotencyKey": "6q5w4e7r8t9y",
  "orderId": "1q2w3e4r5t6t78",
  "kountAccountId": "760000",
  "kountApiKey": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiI3NjAwMDAiLCJhdWQiOiJLb3VudC4xIiwiaWF0IjoxNTU4MDQwODQ5LCJzY3AiOnsia2EiOm51bGwsImtjIjpmYWxzZSwiYXBpIjp0cnVlLCJyaXMiOnRydWV9fQ.y3_2yzd11-Y_F6_xzVsXI-NO1a7P6ldMjDnKzl5yBko",
  "sessionId": "xjudq804i1049jkjakdad",
  "websiteId": "DEFAULT",
  "paymentDetails": {
    "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV"
  },
  "email": "moneris@moneris.com",
  "products": [
    {
      "itemId": "e2ab873e-b295-11e9-9c02",
      "itemType": "Phone",
      "itemQuantity": 82,
      "itemName": "Canned Food",
      "itemAmount": {
        "amount": 15000,
        "currency": "CAD"
      }
    }
  ],
  "automaticNumberId": "0123456789",
  "billingAddress": {
    "unitNumber": "123A",
    "streetNumber": "3300",
    "streetName": "Bloor Street West",
    "city": "Toronto",
    "province": "ON",
    "postalCode": "M8X 2X2",
    "country": "CA"
  },
  "shippingAddress": {
    "unitNumber": "123A",
    "streetNumber": "3300",
    "streetName": "Bloor Street West",
    "city": "Toronto",
    "province": "ON",
    "postalCode": "M8X 2X2",
    "country": "CA"
  },
  "dateOfBirth": "2019-07-30",
  "timestamp": "2019-07-30T06:43:40.252Z",
  "customerName": "John Doe",
  "financialOrderId": "nqa-finorderid-1",
  "ipv4": "104.75.173.179"
}

Response

Kount Inquiry was successfully approved.

kountInquiryIdstring required

Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.

orderIdstring nullable required

Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transaction

Note: No two transactions of these types may have the same order ID. Field only accepts alphanumerical characters, dashes and underscores.

kountResult'APPROVED' | 'DECLINED' | 'UNDER_REVIEW' required

Auto-decision response

fraudScoreinteger nullable

Final risk score returned from Kount system

kountTransactionIdstring required

Kount Transaction ID

browserstring nullable

Web Browser

cardBrand'MASTERCARD' | 'VISA' | 'AMERICAN_EXPRESS' | 'JCB' | 'DISCOVER' | 'INTERAC' | 'UNIONPAY' | 'GIFT_MONERIS' | 'GIFT_DATACANDY' | 'GIFT_GIVEX' | 'null' nullable

Displays the card brand name associated with the card type.

associatedCardCountinteger nullable

Total number of credit cards associated to persona as seen by Kount

cookiesEnabledboolean nullable

A flag to indicate if device placing order has cookies enabled or not

countrystring iso-3166 nullable

Two-character ISO country code associated with the physical device

deviceFirstSeenAtstring date nullable

Date device first seen

deviceLayersstring nullable

5 device layers that comprise the device's fingerprint, representing OS, browser, Javascript, cookies and Flash settings

deviceCountinteger nullable

Total number of unique devices associated to persona as seen by Kount

deviceScreenResolutionstring nullable

Device Screen Resolution

emailCountinteger nullable

Total number of unique email addresses associated to persona as seen by Kount

errorCountinteger nullable

Number of errors the Kount request generated

errorCodestring nullable

Error Code displayed in Risk Inquiry Service response

kountFingerprintstring nullable

The unique fingerprint of the device placing the order

flashEnabledboolean nullable

A flag to indicate if the device placing the order has Flash enabled

riskiestAssociatedCountrystring iso-3166 nullable

Persona related country with highest probability of fraud Refers to Kount's GEOX field.

userDefinedHomeCountrystring iso-3166 nullable

User home country the device owner has set in the device's control panel Refers to Kount's HTTP_COUNTRY

proxyAddressstring ipv4 nullable

IP address of proxy

javascriptEnabledboolean nullable

A flag to indicate if the device placing order has JavaScript enabled

deviceDataCollectedByDataCollectorboolean nullable

Flag indicating whether or not device data was collected by the Data Collector process

knowYourCustomerFlagboolean nullable

Know Your Customer Flag

deviceLanguagestring iso-639 nullable

The two-character ISO language the device owner has set in the device control panel

localTimestring date-time nullable

The local time the device owner has set in the device control panel

isMobileDeviceboolean nullable

Flag to indicate if the device placing the order is a mobile device

usesMobileForwarderboolean nullable

If device is mobile, is it using a forwarder to process the carriers service

mobileTypestring nullable

Type of mobile device, e.g., iPhone, Android, Blackberry, iPad, etc.

kountNetwork'ANONYMOUS' | 'HIGH_SCHOOL' | 'LIBRARY' | 'NORMAL' | 'OPEN_PROXY' | 'PRISON' | 'SATELLITE' | 'null' nullable

Riskiest network type associated with persona within last 14 days:

mode'QUERY' | 'UPDATE' | 'null' nullable

Specifies the Risk Inquiry Service post mode type

Risk Inquiry Service Modes

Modes are used to specify what type of data is being submitted to Kount. Note that ALL FIELD NAMES for a RIS call must be UPPERCASE. They cannot be other case combinations such as sess, Merc, mOdE. However, the values for fields can be mixed case, such as SESS=UpperMixedCaseSessID95628.

  • QUERY = Mode Q Initial queries directed from the merchant to Kount that do not originate from a call center environment.
  • UPDATE = Mode U Update call to Kount, does not cause a reevaluation of the transaction but will update what is displayed in the Agent Web Console. This update call does not count towards the number of RIS transactions purchased. Only certain fields can be updated with MODE=U calls. The PTYP field can only be updated if the initial post to Kount was PTYP=NONE
operatingSystemstring nullable

Operating system of the device

pcRemoteEnabledboolean nullable

Flag indicating whether the device is enabled to use PC remote software

proxyEnabledboolean nullable

Flag indicating whether or not a proxy server is detected

reasonCodestring nullable

Reason code associated with rule action

regionstring nullable

Region associated to device location

riskiestAssociatedRegionstring nullable

Indicates the riskiest geographical location associated with the Persona. Refers to Kount's GEOX.

sessionIdstring nullable

Unique Session ID; must be unique over a 30-day span

websiteIdstring nullable

Website identifier of where order originated

timezonestring nullable

The time zone of the device; In the ISO format of +|–hh:mm

deviceUserAgentstring nullable

Exact content of the HTTP user-agent header. Note, when total length exceeds 2048 characters, truncate the excess portion.

velocityinteger nullable

Quantity of orders seen from persona within last 14 days

maximumVelocityinteger nullable

Quantity of orders from persona within the most active 6 hour window in last 14 days; payment_response field must be equal to ‘A’

kountVersionstring nullable

Specifies version of Kount system being used

deviceVoiceActivatedboolean nullable

If it is a mobile device, flag indicating whether the device is voice activated

warningCountinteger nullable

Number of warnings the Kount Inquiry Service has generated

warningCodestring nullable

Warning code displayed in the Risk Inquiry Service response

warningDetailstring nullable

Warning details

Example response

{
  "kountInquiryId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "orderId": "1q2w3e4r5t6t78",
  "fraudScore": 99,
  "kountTransactionId": "123456789012",
  "browser": "Google Chrome",
  "cardBrand": "MASTERCARD",
  "associatedCardCount": 3,
  "cookiesEnabled": true,
  "country": "CA",
  "deviceFirstSeenAt": "2019-07-30",
  "deviceCount": 2,
  "deviceScreenResolution": "1920x1080",
  "emailCount": 3,
  "errorCount": 3,
  "errorCode": "1080",
  "kountFingerprint": "123456789h123456789p123456789g12",
  "flashEnabled": true,
  "riskiestAssociatedCountry": "CA",
  "userDefinedHomeCountry": "CA",
  "proxyAddress": "104.75.173.179",
  "javascriptEnabled": true,
  "deviceDataCollectedByDataCollector": true,
  "knowYourCustomerFlag": true,
  "deviceLanguage": "en",
  "localTime": "2019-07-30T06:43:40.252Z",
  "isMobileDevice": true,
  "usesMobileForwarder": true,
  "mobileType": "iPhone",
  "operatingSystem": "macOS",
  "pcRemoteEnabled": true,
  "proxyEnabled": true,
  "piercedAddress": {
    "latitude": -90.1922,
    "longitude": 38.6312,
    "city": "Toronto",
    "region": "Ontario",
    "country": "CA"
  },
  "reasonCode": "Invalid Data",
  "region": "CA",
  "riskiestAssociatedRegion": "CA",
  "rulesTriggered": [
    {
      "id": 8,
      "description": "Rule description example"
    }
  ],
  "sessionId": "xjudq804i1049jkjakdad",
  "websiteId": "DEFAULT",
  "timezone": "-04:00",
  "deviceUserAgent": "Mozilla/5.0 (Linux; {Android Version}; {Build Tag etc.})",
  "velocity": 8,
  "maximumVelocity": 8,
  "kountVersion": "1.0",
  "deviceVoiceActivated": true,
  "warningCount": 8,
  "warningCode": "180"
}