Request (kount-ris-sdk 7.4.0 API)

java.lang.Object
- com.kount.ris.Request

Direct Known Subclasses:

Inquiry, Update
```
public abstract class Request
extends Object
```
RIS Request superclass for Inquiry and Update.

Version:

$Id$

Author:

Kount <custserv@kount.com>

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`closeOnFinish` Optional parameter for clients to close the transport when done.
`protected org.apache.logging.log4j.Logger`	`logger` Logger.
`protected Map<String,String>`	`params` Map containing data that will be sent to RIS.

Constructor Summary

Constructors
Constructor and Description

Request()
Class constructor.

Constructors
Constructor and Description
`Request()` Class constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getParams()` Fetch the map of data parameters to send to RIS.
`protected boolean`	`isSetKhashPaymentEncoding()` Check if KHASH payment encoding has been set.
`Request`	`setAuthorizationStatus(AuthorizationStatus authorizationStatus)` Set the Authorization Status.
`Request`	`setAvsAddressReply(BankcardReply avsAddressReply)` Set the Bankcard AVS street addres reply.
`Request`	`setAvsZipReply(BankcardReply avsZipReply)` Set the Bankcard AVS zip code reply.
`Request`	`setCloseOnFinish(boolean cof)` Set a flag for the request transport.
`Request`	`setCvvReply(BankcardReply cvvReply)` Set the Bankcard CVV/CVC/CVV2 reply.
`Request`	`setKcCustomerId(String id)` Set the Kount Central Customer ID.
`Request`	`setKhashPaymentEncoding()` Deprecated. Version 5.0.0. Use method com.kount.ris.Request.setKhashPaymentEncoding(boolean) : Request
`Request`	`setKhashPaymentEncoding(boolean enabled)` Set KHASH payment encoding.
`Request`	`setMerchantAcknowledgment(MerchantAcknowledgment merchantAcknowledgment)` Set the merchant acknowledgment.
`Request`	`setMerchantId(int merchantId)` Set the merchant ID assigned by Kount.
`Request`	`setOrderNumber(String orderNumber)` Set the order number.
`Request`	`setParm(String key, String value)` Set a parm for the request.
`Request`	`setPayment(Payment p)` Set a payment.
`Request`	`setPayment(String ptyp, String ptok)` Set a payment by payment type and payment token.
`Request`	`setPaymentMasked(Payment p)` Sets a card payment and masks the card number in the following way:
`Request`	`setSessionId(String sessionId)` Set the session id.
`Request`	`setVersion(String version)` Set the version number.
`String`	`toString()` To String.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - params
```
protected Map<String,String> params
```
    Map containing data that will be sent to RIS.
  - logger
```
protected org.apache.logging.log4j.Logger logger
```
    Logger.
  - closeOnFinish
```
protected boolean closeOnFinish
```
    Optional parameter for clients to close the transport when done.
- Constructor Detail
  - Request
```
public Request()
```
    Class constructor.
    
    Throws:
    
    RisException
- Method Detail
  - toString
```
public String toString()
```
    To String.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String
  - setParm
```
public Request setParm(String key,
                       String value)
```
    Set a parm for the request.
    
    Parameters:
    
    key - The key for the parm
    
    value - The value for the parm
    
    Returns:
    
    this
  - setVersion
```
public Request setVersion(String version)
```
    Set the version number.
    
    Parameters:
    
    version - The SDK version
    
    Returns:
    
    this
  - setSessionId
```
public Request setSessionId(String sessionId)
```
    Set the session id. Must be unique over a 30-day span
    
    Parameters:
    
    sessionId - Id of the current session
    
    Returns:
    
    this
  - setMerchantId
```
public Request setMerchantId(int merchantId)
```
    Set the merchant ID assigned by Kount.
    
    Parameters:
    
    merchantId - Merchant ID
    
    Returns:
    
    this
  - setKcCustomerId
```
public Request setKcCustomerId(String id)
```
    Set the Kount Central Customer ID.
    
    Parameters:
    
    id - KC Customer ID
    
    Returns:
    
    this
  - setOrderNumber
```
public Request setOrderNumber(String orderNumber)
```
    Set the order number.
    
    Parameters:
    
    orderNumber - Merchant unique order number
    
    Returns:
    
    this
  - setMerchantAcknowledgment
```
public Request setMerchantAcknowledgment(MerchantAcknowledgment merchantAcknowledgment)
```
    Set the merchant acknowledgment.
    Merchants acknowledgement to ship/process the order. The MACK field must be set as 'Y' if persona data is to be collected to strengthen the score.
    
    Parameters:
    
    merchantAcknowledgment - Merchant acknowledgment
    
    Returns:
    
    this
  - setAuthorizationStatus
```
public Request setAuthorizationStatus(AuthorizationStatus authorizationStatus)
```
    Set the Authorization Status.
    Authorization Status returned to merchant from processor. Acceptable values for the AUTH field are ’A’ for Authorized or ’D’ for Decline. In orders where AUTH=A will aggregate towards order velocity of the persona while orders where AUTH=D will decrement the velocity of the persona.
    
    Parameters:
    
    authorizationStatus - Auth status by issuer
    
    Returns:
    
    this
  - setAvsZipReply
```
public Request setAvsZipReply(BankcardReply avsZipReply)
```
    Set the Bankcard AVS zip code reply.
    Address Verification System Zip Code verification response returned to merchant from processor. Acceptable values are ‘M’ for match, ’N’ for no match, or ‘X’ for unsupported or unavailable.
    
    Parameters:
    
    avsZipReply - Bankcard AVS zip code reply
    
    Returns:
    
    this
  - setAvsAddressReply
```
public Request setAvsAddressReply(BankcardReply avsAddressReply)
```
    Set the Bankcard AVS street addres reply.
    Address Verification System Street verification response returned to merchant from processor. Acceptable values are ’M’ for match, ’N’ for no-match, or ’X’ for unsupported or unavailable.
    
    Parameters:
    
    avsAddressReply - Bankcard AVS street addres reply
    
    Returns:
    
    this
  - setCvvReply
```
public Request setCvvReply(BankcardReply cvvReply)
```
    Set the Bankcard CVV/CVC/CVV2 reply.
    Card Verification Value response returned to merchant from processor. Acceptable values are ’M’ for match, ’N’ for no-match, or ’X’ unsupported or unavailable.
    
    Parameters:
    
    cvvReply - Bankcard CVV/CVC/CVV2 reply
    
    Returns:
    
    this
  - setPayment
```
public Request setPayment(Payment p)
```
    Set a payment.
    Depending on the payment type, various request parameters are set: PTOK, PTYP, LAST4.
    If payment token hashing is not possible, the PENC parameter is set to empty string.
    
    Parameters:
    
    p - Payment
    
    Returns:
    
    this
  - setPaymentMasked
```
public Request setPaymentMasked(Payment p)
```
    Sets a card payment and masks the card number in the following way:
    First 6 characters remain as they are, following characters up to the last 4 are replaced with the 'X' character, last 4 characters remain as they are.
    If the provided Payment parameter is not a card payment, standard encoding will be applied.
    This method sets the following RIS Request fields: PTOK, PTYP, LAST4, PENC.
    
    Parameters:
    
    p - Payment -- card payment
    
    Returns:
    
    this
  - setPayment
```
public Request setPayment(String ptyp,
                          String ptok)
```
    Set a payment by payment type and payment token.
    The payment type parameter provided is checked if it's one of the predefined payment types and Payment is created appropriately
    
    Parameters:
    
    ptyp - See SDK documentation for a list of accepted payment types
    
    ptok - The payment token
    
    Returns:
    
    this
  - getParams
```
public Map<String,String> getParams()
```
    Fetch the map of data parameters to send to RIS.
    
    Returns:
    
    Map of params
  - setKhashPaymentEncoding
```
public Request setKhashPaymentEncoding()
```
    Deprecated. Version 5.0.0. Use method com.kount.ris.Request.setKhashPaymentEncoding(boolean) : Request
    
    Set KHASH payment encoding.
    
    Returns:
    
    this
  - setKhashPaymentEncoding
```
public Request setKhashPaymentEncoding(boolean enabled)
```
    Set KHASH payment encoding.
    
    Parameters:
    
    enabled - TRUE when enabled.
    
    Returns:
    
    this
  - isSetKhashPaymentEncoding
```
protected boolean isSetKhashPaymentEncoding()
```
    Check if KHASH payment encoding has been set.
    
    Returns:
    
    boolean TRUE when set.
  - setCloseOnFinish
```
public Request setCloseOnFinish(boolean cof)
```
    Set a flag for the request transport.
    
    Parameters:
    
    cof - Sets the closeOnFinish flag
    
    Returns:
    
    this

Class Request

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

params

logger

closeOnFinish

Constructor Detail

Request

Method Detail

toString

setParm

setVersion

setSessionId

setMerchantId

setKcCustomerId

setOrderNumber

setMerchantAcknowledgment

setAuthorizationStatus

setAvsZipReply

setAvsAddressReply

setCvvReply

setPayment

setPaymentMasked

setPayment

getParams

setKhashPaymentEncoding

setKhashPaymentEncoding

isSetKhashPaymentEncoding

setCloseOnFinish