java.lang.Object
- com.checkout.handlepaymentsandpayouts.payments.common.source.AbstractSource
- - com.checkout.handlepaymentsandpayouts.payments.common.source.knetsource.KnetSource

public final class KnetSource
extends AbstractSource

knet source Class The source of the payment

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class KnetSource.KnetSourceBuilder

Field Summary
- Fields inherited from class com.checkout.handlepaymentsandpayouts.payments.common.source.AbstractSource
  type

Constructor Summary

Constructors
Constructor Description

KnetSource()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static KnetSource.KnetSourceBuilder`	`builder()`
`protected boolean`	`canEqual(java.lang.Object other)`
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getAuthCode()`	The resulting authorization code from the issuing bank.
`java.lang.String`	`getAuthResponseCode()`	The auth response code / reason code relating to the issuing bank authorization code.
`java.lang.String`	`getAvr()`	The Address Verification Response returned from the address verification service.
`java.lang.String`	`getBankReference()`	The result transaction reference, given by some banks/institutions.
`java.lang.String`	`getCardToken()`	This token allows re-usage of card details for multiple payments.
`java.lang.String`	`getError()`	The KNET error code for transaction processing.
`java.lang.String`	`getErrorText()`	The KNET text detail for the error, including an error code.
`java.lang.String`	`getInquiryResult()`	The state of the payment, returned by KNet Gateway in the response from the payment inquiry.
`java.lang.String`	`getKnetPaymentId()`	The payment identifier assigned by KNet Gateway.
`java.lang.String`	`getKnetResult()`	The state of the payment, returned by KNet Gateway after the customer is redirected from the payment page.
`java.lang.String`	`getKnetTransactionId()`	The transaction identifier assigned by KNet Gateway.
`LanguageType`	`getLanguage()`	Required for KNet Gateway payments.
`java.lang.String`	`getPostDate()`	The transaction date in the authorization system format, with the value defined by the issuing bank, so may not match the actual transaction date.
`java.lang.String`	`getPtlf()`	This is an ID for merchant PTLF functionality tracking.
`java.lang.String`	`getUserDefinedFieldFive()`	User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`java.lang.String`	`getUserDefinedFieldFour()`	User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`java.lang.String`	`getUserDefinedFieldOne()`	User-defined field that can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`java.lang.String`	`getUserDefinedFieldThree()`	User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`java.lang.String`	`getUserDefinedFieldTwo()`	User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`int`	`hashCode()`
`void`	`setAuthCode(java.lang.String authCode)`	The resulting authorization code from the issuing bank.
`void`	`setAuthResponseCode(java.lang.String authResponseCode)`	The auth response code / reason code relating to the issuing bank authorization code.
`void`	`setAvr(java.lang.String avr)`	The Address Verification Response returned from the address verification service.
`void`	`setBankReference(java.lang.String bankReference)`	The result transaction reference, given by some banks/institutions.
`void`	`setCardToken(java.lang.String cardToken)`	This token allows re-usage of card details for multiple payments.
`void`	`setError(java.lang.String error)`	The KNET error code for transaction processing.
`void`	`setErrorText(java.lang.String errorText)`	The KNET text detail for the error, including an error code.
`void`	`setInquiryResult(java.lang.String inquiryResult)`	The state of the payment, returned by KNet Gateway in the response from the payment inquiry.
`void`	`setKnetPaymentId(java.lang.String knetPaymentId)`	The payment identifier assigned by KNet Gateway.
`void`	`setKnetResult(java.lang.String knetResult)`	The state of the payment, returned by KNet Gateway after the customer is redirected from the payment page.
`void`	`setKnetTransactionId(java.lang.String knetTransactionId)`	The transaction identifier assigned by KNet Gateway.
`void`	`setLanguage(LanguageType language)`	Required for KNet Gateway payments.
`void`	`setPostDate(java.lang.String postDate)`	The transaction date in the authorization system format, with the value defined by the issuing bank, so may not match the actual transaction date.
`void`	`setPtlf(java.lang.String ptlf)`	This is an ID for merchant PTLF functionality tracking.
`void`	`setUserDefinedFieldFive(java.lang.String userDefinedFieldFive)`	User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`void`	`setUserDefinedFieldFour(java.lang.String userDefinedFieldFour)`	User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`void`	`setUserDefinedFieldOne(java.lang.String userDefinedFieldOne)`	User-defined field that can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`void`	`setUserDefinedFieldThree(java.lang.String userDefinedFieldThree)`	User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`void`	`setUserDefinedFieldTwo(java.lang.String userDefinedFieldTwo)`	User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion.
`java.lang.String`	`toString()`

Methods inherited from class com.checkout.handlepaymentsandpayouts.payments.common.source.AbstractSource
getType

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

- Constructor Detail
  - KnetSource
```
public KnetSource()
```
- Method Detail
  - builder
```
public static KnetSource.KnetSourceBuilder builder()
```
  - getLanguage
```
public LanguageType getLanguage()
```
    Required for KNet Gateway payments. This field enables the issuer's site to select the consumer's preferred language. For example, the language selected on the merchant's site – if the issuer's site supports it. Code list in accordance with ISO 639-1. (Arabic = 'ar', English = 'en'). Note that 'ar' corresponds to 'ARA' and 'en' to 'USA'. Both values accepted by KNet Gateway. [Optional]
  - getUserDefinedFieldOne
```
public java.lang.String getUserDefinedFieldOne()
```
    User-defined field that can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. [Optional]
  - getUserDefinedFieldTwo
```
public java.lang.String getUserDefinedFieldTwo()
```
    User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. [Optional]
  - getUserDefinedFieldThree
```
public java.lang.String getUserDefinedFieldThree()
```
    User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. Note that this field must be omitted when the card_token field is not empty. This restriction exists because a card token is passed to KNet Gateway as user_defined_field3. [Optional]
  - getUserDefinedFieldFour
```
public java.lang.String getUserDefinedFieldFour()
```
    User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. [Optional]
  - getUserDefinedFieldFive
```
public java.lang.String getUserDefinedFieldFive()
```
    User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. Note that this field must be omitted when the ptlf field is not empty. This restriction exists because a PTLF value is passed to KNet Gateway as user_defined_field5. [Optional]
  - getCardToken
```
public java.lang.String getCardToken()
```
    This token allows re-usage of card details for multiple payments. This 8-digit token should be generated by a merchant. When a subsequent payment is initialized with the same card token, a customer is presented with two options. The customer can choose to pay with KFast (doesn't need to enter card details again), or with KNet as usual. The payment flow stays the same i.e. a merchant should redirect a customer to the redirect URL which is provided in the payment creation response. Note that user_defined_field3 must be omitted when the card_token field is not empty. This restriction exists because a card token is passed to KNet Gateway as user_defined_field3. [Optional] ^[0-9]{8}$
  - getPtlf
```
public java.lang.String getPtlf()
```
    This is an ID for merchant PTLF functionality tracking. Only alphanumeric characters are allowed. Note that user_defined_field5 must be omitted when the ptlf field is not empty. This restriction exists because a PTLF value is passed to KNet Gateway as user_defined_field5. [Optional] <= 45
  - getKnetPaymentId
```
public java.lang.String getKnetPaymentId()
```
    The payment identifier assigned by KNet Gateway. [Optional]
  - getKnetResult
```
public java.lang.String getKnetResult()
```
    The state of the payment, returned by KNet Gateway after the customer is redirected from the payment page. [Optional]
  - getInquiryResult
```
public java.lang.String getInquiryResult()
```
    The state of the payment, returned by KNet Gateway in the response from the payment inquiry. This field is populated in rare cases when the redirection from the payment page did not occur properly. [Optional]
  - getBankReference
```
public java.lang.String getBankReference()
```
    The result transaction reference, given by some banks/institutions. [Optional]
  - getKnetTransactionId
```
public java.lang.String getKnetTransactionId()
```
    The transaction identifier assigned by KNet Gateway. [Optional]
  - getAuthCode
```
public java.lang.String getAuthCode()
```
    The resulting authorization code from the issuing bank. [Optional]
  - getAuthResponseCode
```
public java.lang.String getAuthResponseCode()
```
    The auth response code / reason code relating to the issuing bank authorization code. [Optional]
  - getPostDate
```
public java.lang.String getPostDate()
```
    The transaction date in the authorization system format, with the value defined by the issuing bank, so may not match the actual transaction date. The format is MMDD. [Optional]
  - getAvr
```
public java.lang.String getAvr()
```
    The Address Verification Response returned from the address verification service. [Optional]
  - getError
```
public java.lang.String getError()
```
    The KNET error code for transaction processing. [Optional]
  - getErrorText
```
public java.lang.String getErrorText()
```
    The KNET text detail for the error, including an error code. [Optional]
  - setLanguage
```
public void setLanguage(LanguageType language)
```
    Required for KNet Gateway payments. This field enables the issuer's site to select the consumer's preferred language. For example, the language selected on the merchant's site – if the issuer's site supports it. Code list in accordance with ISO 639-1. (Arabic = 'ar', English = 'en'). Note that 'ar' corresponds to 'ARA' and 'en' to 'USA'. Both values accepted by KNet Gateway. [Optional]
  - setUserDefinedFieldOne
```
public void setUserDefinedFieldOne(java.lang.String userDefinedFieldOne)
```
    User-defined field that can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. [Optional]
  - setUserDefinedFieldTwo
```
public void setUserDefinedFieldTwo(java.lang.String userDefinedFieldTwo)
```
    User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. [Optional]
  - setUserDefinedFieldThree
```
public void setUserDefinedFieldThree(java.lang.String userDefinedFieldThree)
```
    User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. Note that this field must be omitted when the card_token field is not empty. This restriction exists because a card token is passed to KNet Gateway as user_defined_field3. [Optional]
  - setUserDefinedFieldFour
```
public void setUserDefinedFieldFour(java.lang.String userDefinedFieldFour)
```
    User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. [Optional]
  - setUserDefinedFieldFive
```
public void setUserDefinedFieldFive(java.lang.String userDefinedFieldFive)
```
    User-defined field can be used to pass and store any additional transaction data required to be archived with the transaction and available as a searching criterion. Only alphanumeric characters and spaces are allowed. Note that this field must be omitted when the ptlf field is not empty. This restriction exists because a PTLF value is passed to KNet Gateway as user_defined_field5. [Optional]
  - setCardToken
```
public void setCardToken(java.lang.String cardToken)
```
    This token allows re-usage of card details for multiple payments. This 8-digit token should be generated by a merchant. When a subsequent payment is initialized with the same card token, a customer is presented with two options. The customer can choose to pay with KFast (doesn't need to enter card details again), or with KNet as usual. The payment flow stays the same i.e. a merchant should redirect a customer to the redirect URL which is provided in the payment creation response. Note that user_defined_field3 must be omitted when the card_token field is not empty. This restriction exists because a card token is passed to KNet Gateway as user_defined_field3. [Optional] ^[0-9]{8}$
  - setPtlf
```
public void setPtlf(java.lang.String ptlf)
```
    This is an ID for merchant PTLF functionality tracking. Only alphanumeric characters are allowed. Note that user_defined_field5 must be omitted when the ptlf field is not empty. This restriction exists because a PTLF value is passed to KNet Gateway as user_defined_field5. [Optional] <= 45
  - setKnetPaymentId
```
public void setKnetPaymentId(java.lang.String knetPaymentId)
```
    The payment identifier assigned by KNet Gateway. [Optional]
  - setKnetResult
```
public void setKnetResult(java.lang.String knetResult)
```
    The state of the payment, returned by KNet Gateway after the customer is redirected from the payment page. [Optional]
  - setInquiryResult
```
public void setInquiryResult(java.lang.String inquiryResult)
```
    The state of the payment, returned by KNet Gateway in the response from the payment inquiry. This field is populated in rare cases when the redirection from the payment page did not occur properly. [Optional]
  - setBankReference
```
public void setBankReference(java.lang.String bankReference)
```
    The result transaction reference, given by some banks/institutions. [Optional]
  - setKnetTransactionId
```
public void setKnetTransactionId(java.lang.String knetTransactionId)
```
    The transaction identifier assigned by KNet Gateway. [Optional]
  - setAuthCode
```
public void setAuthCode(java.lang.String authCode)
```
    The resulting authorization code from the issuing bank. [Optional]
  - setAuthResponseCode
```
public void setAuthResponseCode(java.lang.String authResponseCode)
```
    The auth response code / reason code relating to the issuing bank authorization code. [Optional]
  - setPostDate
```
public void setPostDate(java.lang.String postDate)
```
    The transaction date in the authorization system format, with the value defined by the issuing bank, so may not match the actual transaction date. The format is MMDD. [Optional]
  - setAvr
```
public void setAvr(java.lang.String avr)
```
    The Address Verification Response returned from the address verification service. [Optional]
  - setError
```
public void setError(java.lang.String error)
```
    The KNET error code for transaction processing. [Optional]
  - setErrorText
```
public void setErrorText(java.lang.String errorText)
```
    The KNET text detail for the error, including an error code. [Optional]
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class AbstractSource
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
    Overrides:
    
    canEqual in class AbstractSource
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractSource
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class AbstractSource

Class KnetSource

Nested Class Summary

Field Summary

Fields inherited from class com.checkout.handlepaymentsandpayouts.payments.common.source.AbstractSource

Constructor Summary

Method Summary

Methods inherited from class com.checkout.handlepaymentsandpayouts.payments.common.source.AbstractSource

Methods inherited from class java.lang.Object

Constructor Detail

KnetSource

Method Detail

builder

getLanguage

getUserDefinedFieldOne

getUserDefinedFieldTwo

getUserDefinedFieldThree

getUserDefinedFieldFour

getUserDefinedFieldFive

getCardToken

getPtlf

getKnetPaymentId

getKnetResult

getInquiryResult

getBankReference

getKnetTransactionId

getAuthCode

getAuthResponseCode

getPostDate

getAvr

getError

getErrorText

setLanguage

setUserDefinedFieldOne

setUserDefinedFieldTwo

setUserDefinedFieldThree

setUserDefinedFieldFour

setUserDefinedFieldFive

setCardToken

setPtlf

setKnetPaymentId

setKnetResult

setInquiryResult

setBankReference

setKnetTransactionId

setAuthCode

setAuthResponseCode

setPostDate

setAvr

setError

setErrorText

equals

canEqual

hashCode

toString