POST api/Integration/Kount/RiskInquiry

Sends the risk inquiry request.

Request Information

URI Parameters

None.

Body Parameters

The payload.

KountInquiryViewModel
NameDescriptionTypeAdditional information
IpAddress

The ip address.

 string

None.
UniqueSessionId

The unique session identifier.

 string

None.
OnlineOrderId

The online order identifier.

 integer

None.
CurrencyTypeId

The currency type identifier.

 string

None.
TotalAmount

The total amount.

 decimal number

None.
Email

The email.

 string

None.
PaymentType

Gets or sets the type of the payment.

 string

None.
CardName

Gets or sets the name of the card.

 string

None.
CardNumber

The card number.

 string

None.
CardHashMethod

The hashing method applied to CardNumber. Options: BDT - ByDesign encryption method. Given CardNumber will be decryted and converted to Khash before to be sent to Kount api. Preferred in BDT systems. KHASH - Given CardNumber will be directly sent to Kount api. Hashing must happend at client end. Must use same hash key configured in Kount and ByDesign Backoffice. PLAIN - Given CardNumber will be converted to Khash before to be sent to Kount api. Prefer to implement KLASH option instead.

 CardHashMethod

None.
Last4

The last 4 digits of the card number.

 string

None.
County

The ship county.

 string

None.
City

The ship city.

 string

None.
State

The ship state.

 string

None.
PostalCode

The ship postal code.

 string

None.
Country

The ship country.

 string

None.
Phone

The ship phone.

 string

None.
ProductItems

The product items.

 Collection of KountProductItem

None.
OrderType

The type of the order. Options: SHOP or ENROLL.

 OrderType

None.
CCProcessorID

Credit card processor ID.

 string

None.

Request Formats

application/xml, text/xml

Sample: 
<KountInquiryViewModel>
  <IpAddress>sample string 1</IpAddress>
  <UniqueSessionId>sample string 2</UniqueSessionId>
  <OnlineOrderId>3</OnlineOrderId>
  <CurrencyTypeId>sample string 4</CurrencyTypeId>
  <TotalAmount>1</TotalAmount>
  <Email>sample string 5</Email>
  <PaymentType>sample string 6</PaymentType>
  <CardName>sample string 7</CardName>
  <CardNumber>sample string 8</CardNumber>
  <CardHashMethod>BDT</CardHashMethod>
  <Last4>sample string 9</Last4>
  <County>sample string 10</County>
  <City>sample string 11</City>
  <State>sample string 12</State>
  <PostalCode>sample string 13</PostalCode>
  <Country>sample string 14</Country>
  <Phone>sample string 15</Phone>
  <ProductItems>
    <KountProductItem>
      <CategoryId>1</CategoryId>
      <Description>sample string 1</Description>
      <Quantity>1</Quantity>
      <Price>1</Price>
      <ProductId>sample string 2</ProductId>
    </KountProductItem>
    <KountProductItem>
      <CategoryId>1</CategoryId>
      <Description>sample string 1</Description>
      <Quantity>1</Quantity>
      <Price>1</Price>
      <ProductId>sample string 2</ProductId>
    </KountProductItem>
  </ProductItems>
  <OrderType>SHOP</OrderType>
  <CCProcessorID>sample string 16</CCProcessorID>
</KountInquiryViewModel>

application/json, text/json

Sample: 
{
  "IpAddress": "sample string 1",
  "UniqueSessionId": "sample string 2",
  "OnlineOrderId": 3,
  "CurrencyTypeId": "sample string 4",
  "TotalAmount": 1.0,
  "Email": "sample string 5",
  "PaymentType": "sample string 6",
  "CardName": "sample string 7",
  "CardNumber": "sample string 8",
  "CardHashMethod": "BDT",
  "Last4": "sample string 9",
  "County": "sample string 10",
  "City": "sample string 11",
  "State": "sample string 12",
  "PostalCode": "sample string 13",
  "Country": "sample string 14",
  "Phone": "sample string 15",
  "ProductItems": [
    {
      "CategoryId": 1,
      "Description": "sample string 1",
      "Quantity": 1,
      "Price": 1.0,
      "ProductId": "sample string 2"
    },
    {
      "CategoryId": 1,
      "Description": "sample string 1",
      "Quantity": 1,
      "Price": 1.0,
      "ProductId": "sample string 2"
    }
  ],
  "OrderType": "SHOP",
  "CCProcessorID": "sample string 16"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'KountInquiryViewModel'.

Response Information

Resource Description

KountInquiryResponseViewModel
NameDescriptionTypeAdditional information
MerchantOrderNumber

The merchant order number.

 string

None.
KountTransactionId

The kount transaction identifier.

 string

None.
KountStatus

The kount status.

 string

None.
KountScore

The kount score.

 decimal number

None.
KountOmniScore

The kount omni score.

 decimal number

None.
KountReasonCode

The kount reason code.

 string

None.
Action

The action. Possible values: ACCEPT, DECLINE, REVIEW and ESCALATE.

 string

None.
ActionMessage

The action message to be displayed to the client.

 string

None.
ActionMessageTranslationKey

The BDT translation key assigned to the action message.

 string

None.
InternalMessage

The internal message.

 string

None.

Response Formats

application/xml, text/xml

Sample: 
<KountInquiryResponseViewModel>
  <MerchantOrderNumber>sample string 1</MerchantOrderNumber>
  <KountTransactionId>sample string 2</KountTransactionId>
  <KountStatus>sample string 3</KountStatus>
  <KountScore>1</KountScore>
  <KountOmniScore>1</KountOmniScore>
  <KountReasonCode>sample string 4</KountReasonCode>
  <Action>sample string 5</Action>
  <ActionMessage>sample string 6</ActionMessage>
  <ActionMessageTranslationKey>sample string 7</ActionMessageTranslationKey>
  <InternalMessage>sample string 8</InternalMessage>
</KountInquiryResponseViewModel>

application/json, text/json

Sample: 
{
  "MerchantOrderNumber": "sample string 1",
  "KountTransactionId": "sample string 2",
  "KountStatus": "sample string 3",
  "KountScore": 1.0,
  "KountOmniScore": 1.0,
  "KountReasonCode": "sample string 4",
  "Action": "sample string 5",
  "ActionMessage": "sample string 6",
  "ActionMessageTranslationKey": "sample string 7",
  "InternalMessage": "sample string 8"
}