com.konakart.appif

Interface PaymentDetailsIf

All Known Implementing Classes:

PaymentDetails

public interface PaymentDetailsIf

An order may have a PaymentDetails object to describe the payment method. This object is generated by a payment module.

Payment modules may be enabled and disabled using the KonaKart Admin App so that you can control the payment methods that can be used by your application.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCcCVV()
java.lang.String	getCcExpiryMonth()
java.lang.String	getCcExpiryYear()
java.lang.String	getCcNumber()
java.lang.String	getCcOwner()
java.lang.String	getCcPostcode()
java.lang.String	getCcStreetAddress()
java.lang.String	getCcType()
java.lang.String	getCode() The code of the payment gateway.
CreditCardIf[]	getCreditCards() Contains a list of available credit cards.
java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
java.lang.String	getDescription() The payment gateway description to put on the UI so that it can be selected.
int	getOrderStatusId()
NameValueIf[]	getParameters() An array of name value pairs which are the parameters that will be posted to the payment gateway.
PaymentDetailsIf[]	getPaymentDetails() The payment details object may consist of more than one payment details objects.
int	getPaymentType() The supported payment types are: com.konakart.app.PaymentDetails.COD - Cash on delivery com.konakart.app.PaymentDetails.BROWSER_PAYMENT_GATEWAY - Payment gateway where user is redirected to gateway server to enter credit card details e.g.
java.lang.String	getPostOrGet() Defines whether to use a POST or GET to send the parameters.
java.lang.String	getPreProcessCode() Information for framework to indicate that some pre-processing code needs to be run for this Payment Gateway
java.lang.String	getReferrer() Gets the Referrer - sometimes required to be set on an HTTP post.
java.lang.String	getRequestUrl() The payment gateway url.
int	getSortOrder() Defines the order in which the payment gateways are displayed.
java.lang.String	getSubCode() One PaymentDetails code can have multiple subCodes as well (eg.
int	getSubSortOrder() Defines the subSortOrder in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.
java.lang.String	getTitle() The title of the payment gateway which can be used in the UI.
boolean	isShowAddr() If set to true, the UI page where credit card details are entered, will display an address field.
boolean	isShowCVV() If set to true, the UI page where credit card details are entered, will display a CVV field.
boolean	isShowOwner() If set to true, the UI page where credit card details are entered, will display an owner field to enter the name of the credit card owner.
boolean	isShowPostcode() If set to true, the UI page where credit card details are entered, will display a postcode field.
boolean	isShowType() If set to true, the UI page where credit card details are entered, will display a a credit card type field.
void	setCcCVV(java.lang.String ccCVV)
void	setCcExpiryMonth(java.lang.String ccExpiryMonth)
void	setCcExpiryYear(java.lang.String ccExpiryYear)
void	setCcNumber(java.lang.String ccNumber)
void	setCcOwner(java.lang.String ccOwner)
void	setCcPostcode(java.lang.String ccPostcode)
void	setCcStreetAddress(java.lang.String ccStreetAddress)
void	setCcType(java.lang.String ccType)
void	setCode(java.lang.String code) The code of the payment gateway.
void	setCreditCards(CreditCardIf[] creditCards) Contains a list of available credit cards.
void	setCustom1(java.lang.String custom1)
void	setCustom2(java.lang.String custom2)
void	setCustom3(java.lang.String custom3)
void	setCustom4(java.lang.String custom4)
void	setCustom5(java.lang.String custom5)
void	setDescription(java.lang.String description) The payment gateway description to put on the UI so that it can be selected.
void	setOrderStatusId(int orderStatusId)
void	setParameters(NameValueIf[] parameters) An array of name value pairs which are the parameters that will be posted to the payment gateway.
void	setPaymentDetails(PaymentDetailsIf[] paymentDetails) The payment details object may consist of more than one payment details objects.
void	setPaymentType(int paymentType) The supported payment types are: com.konakart.app.PaymentDetails.COD - Cash on delivery com.konakart.app.PaymentDetails.BROWSER_PAYMENT_GATEWAY - Payment gateway where user is redirected to gateway server to enter credit card details e.g.
void	setPostOrGet(java.lang.String postOrGet) Defines whether to use a POST or GET to send the parameters.
void	setPreProcessCode(java.lang.String preProcessCode) Information for framework to indicate that some pre-processing code needs to be run for this Payment Gateway
void	setReferrer(java.lang.String referrer) Sets the Referrer - sometimes required to be set on an HTTP post.
void	setRequestUrl(java.lang.String requestUrl) The payment gateway url.
void	setShowAddr(boolean showAddr) If set to true, the UI page where credit card details are entered, will display an address field.
void	setShowCVV(boolean showCVV) If set to true, the UI page where credit card details are entered, will display a CVV field.
void	setShowOwner(boolean showOwner) If set to true, the UI page where credit card details are entered, will display an owner field to enter the name of the credit card owner.
void	setShowPostcode(boolean showPostcode) If set to true, the UI page where credit card details are entered, will display a postcode field.
void	setShowType(boolean showType) If set to true, the UI page where credit card details are entered, will display a credit card type field.
void	setSortOrder(int sortOrder) Defines the order in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.
void	setSubCode(java.lang.String subCode) One PaymentDetails code can have multiple subCodes as well (eg.
void	setSubSortOrder(int subSortOrder) Defines the subSortOrder in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.
void	setTitle(java.lang.String title) The title of the payment gateway which can be used in the UI.

Method Detail

setPaymentDetails

void setPaymentDetails(PaymentDetailsIf[] paymentDetails)

The payment details object may consist of more than one payment details objects. If this array is non-null the payment details are recorded here and not at the top level in the object.

Parameters:

paymentDetails - an array of PaymentDetails objects

getPaymentDetails

PaymentDetailsIf[] getPaymentDetails()

The payment details object may consist of more than one payment details objects. If this array is non-null the payment details are recorded here and not at the top level in the object.

Returns:

an array of PaymentDetails objects

getParameters

NameValueIf[] getParameters()

An array of name value pairs which are the parameters that will be posted to the payment gateway.

Returns:

Returns the parameters.

setParameters

void setParameters(NameValueIf[] parameters)

An array of name value pairs which are the parameters that will be posted to the payment gateway.

Parameters:

parameters - The parameters to set.

getReferrer

java.lang.String getReferrer()

Gets the Referrer - sometimes required to be set on an HTTP post.

Returns:

Returns the Referrer.

setReferrer

void setReferrer(java.lang.String referrer)

Sets the Referrer - sometimes required to be set on an HTTP post.

Parameters:

referrer - the Referrer to set

getPostOrGet

java.lang.String getPostOrGet()

Defines whether to use a POST or GET to send the parameters. Should be set to "post" or "get".

Returns:

Returns the postOrGet.

setPostOrGet

void setPostOrGet(java.lang.String postOrGet)

Defines whether to use a POST or GET to send the parameters. Should be set to "post" or "get".

Parameters:

postOrGet - The postOrGet to set.

getRequestUrl

java.lang.String getRequestUrl()

The payment gateway url.

Returns:

Returns the requestUrl.

setRequestUrl

void setRequestUrl(java.lang.String requestUrl)

The payment gateway url.

Parameters:

requestUrl - The requestUrl to set.

getCode

java.lang.String getCode()

The code of the payment gateway. e.g. chronopay, worldpay etc.

Returns:

Returns the code.

setCode

void setCode(java.lang.String code)

The code of the payment gateway. e.g. chronopay, worldpay etc.

Parameters:

code - The code to set.

getSubCode

java.lang.String getSubCode()

One PaymentDetails code can have multiple subCodes as well (eg. for GlobalCollect)

Returns:

the subCode

setSubCode

void setSubCode(java.lang.String subCode)

One PaymentDetails code can have multiple subCodes as well (eg. for GlobalCollect)

Parameters:

subCode - the subCode to set

getDescription

java.lang.String getDescription()

The payment gateway description to put on the UI so that it can be selected.

Returns:

Returns the description.

setDescription

void setDescription(java.lang.String description)

The payment gateway description to put on the UI so that it can be selected.

Parameters:

description - The description to set.

getSortOrder

int getSortOrder()

Defines the order in which the payment gateways are displayed.

Returns:

Returns the sortOrder.

setSortOrder

void setSortOrder(int sortOrder)

Defines the order in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.

Parameters:

sortOrder - The sortOrder to set.

getSubSortOrder

int getSubSortOrder()

Defines the subSortOrder in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.

Returns:

the subSortOrder

setSubSortOrder

void setSubSortOrder(int subSortOrder)

Defines the subSortOrder in which the payment gateways are displayed - order first by sortOrder, then by subSortOrder.

Parameters:

subSortOrder - the subSortOrder to set

getTitle

java.lang.String getTitle()

The title of the payment gateway which can be used in the UI.

Returns:

Returns the title.

setTitle

void setTitle(java.lang.String title)

The title of the payment gateway which can be used in the UI.

Parameters:

title - The title to set.

getOrderStatusId

int getOrderStatusId()

Returns:

Returns the orderStatusId.

setOrderStatusId

void setOrderStatusId(int orderStatusId)

Parameters:

orderStatusId - The orderStatusId to set.

getPaymentType

int getPaymentType()

The supported payment types are:

• com.konakart.app.PaymentDetails.COD - Cash on delivery
• com.konakart.app.PaymentDetails.BROWSER_PAYMENT_GATEWAY - Payment gateway where user is redirected to gateway server to enter credit card details e.g. chronopay, worldpay
• com.konakart.app.PaymentDetails.SERVER_PAYMENT_GATEWAY - Payment gateway where credit card details are collected on a KonaKart web page and sent server to server to the payment gateway. e.g. usaepay

Returns:

Returns the paymentType.

setPaymentType

void setPaymentType(int paymentType)

The supported payment types are:

• com.konakart.app.PaymentDetails.COD - Cash on delivery
• com.konakart.app.PaymentDetails.BROWSER_PAYMENT_GATEWAY - Payment gateway where user is redirected to gateway server to enter credit card details e.g. chronopay, worldpay
• com.konakart.app.PaymentDetails.SERVER_PAYMENT_GATEWAY - Payment gateway where credit card details are collected on a KonaKart web page and sent server to server to the payment gateway. e.g. usaepay

Parameters:

paymentType - The paymentType to set.

getCcNumber

java.lang.String getCcNumber()

Returns:

Returns the ccNumber.

setCcNumber

void setCcNumber(java.lang.String ccNumber)

Parameters:

ccNumber - The ccNumber to set.

getCcPostcode

java.lang.String getCcPostcode()

Returns:

Returns the ccPostcode.

setCcPostcode

void setCcPostcode(java.lang.String ccPostcode)

Parameters:

ccPostcode - The ccPostcode to set.

getCcStreetAddress

java.lang.String getCcStreetAddress()

Returns:

Returns the ccStreetAddress.

setCcStreetAddress

void setCcStreetAddress(java.lang.String ccStreetAddress)

Parameters:

ccStreetAddress - The ccStreetAddress to set.

getCustom1

java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - The custom1 to set.

getCustom2

java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - The custom2 to set.

getCustom3

java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - The custom3 to set.

getCustom4

java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

void setCustom4(java.lang.String custom4)

Parameters:

custom4 - The custom4 to set.

getCustom5

java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

void setCustom5(java.lang.String custom5)

Parameters:

custom5 - The custom5 to set.

getCcCVV

java.lang.String getCcCVV()

Returns:

Returns the ccCVV.

setCcCVV

void setCcCVV(java.lang.String ccCVV)

Parameters:

ccCVV - The ccCVV to set.

getCcOwner

java.lang.String getCcOwner()

Returns:

Returns the ccOwner.

setCcOwner

void setCcOwner(java.lang.String ccOwner)

Parameters:

ccOwner - The ccOwner to set.

getCcType

java.lang.String getCcType()

Returns:

Returns the ccType.

setCcType

void setCcType(java.lang.String ccType)

Parameters:

ccType - The ccType to set.

isShowAddr

boolean isShowAddr()

If set to true, the UI page where credit card details are entered, will display an address field.

Returns:

Returns the showAddr.

setShowAddr

void setShowAddr(boolean showAddr)

If set to true, the UI page where credit card details are entered, will display an address field.

Parameters:

showAddr - The showAddr to set.

isShowCVV

boolean isShowCVV()

If set to true, the UI page where credit card details are entered, will display a CVV field.

Returns:

Returns the showCVV.

setShowCVV

void setShowCVV(boolean showCVV)

If set to true, the UI page where credit card details are entered, will display a CVV field.

Parameters:

showCVV - The showCVV to set.

isShowPostcode

boolean isShowPostcode()

If set to true, the UI page where credit card details are entered, will display a postcode field.

Returns:

Returns the showPostcode.

setShowPostcode

void setShowPostcode(boolean showPostcode)

If set to true, the UI page where credit card details are entered, will display a postcode field.

Parameters:

showPostcode - The showPostcode to set.

isShowType

boolean isShowType()

If set to true, the UI page where credit card details are entered, will display a a credit card type field.

Returns:

Returns the showType.

setShowType

void setShowType(boolean showType)

If set to true, the UI page where credit card details are entered, will display a credit card type field.

Parameters:

showType - The showType to set.

getCcExpiryMonth

java.lang.String getCcExpiryMonth()

Returns:

Returns the ccExpiryMonth.

setCcExpiryMonth

void setCcExpiryMonth(java.lang.String ccExpiryMonth)

Parameters:

ccExpiryMonth - The ccExpiryMonth to set.

getCcExpiryYear

java.lang.String getCcExpiryYear()

Returns:

Returns the ccExpiryYear.

setCcExpiryYear

void setCcExpiryYear(java.lang.String ccExpiryYear)

Parameters:

ccExpiryYear - The ccExpiryYear to set.

isShowOwner

boolean isShowOwner()

If set to true, the UI page where credit card details are entered, will display an owner field to enter the name of the credit card owner.

Returns:

Returns the showOwner.

setShowOwner

void setShowOwner(boolean showOwner)

If set to true, the UI page where credit card details are entered, will display an owner field to enter the name of the credit card owner.

Parameters:

showOwner - The showOwner to set.

getPreProcessCode

java.lang.String getPreProcessCode()

Information for framework to indicate that some pre-processing code needs to be run for this Payment Gateway

Returns:

the preProcessCode

setPreProcessCode

void setPreProcessCode(java.lang.String preProcessCode)

Information for framework to indicate that some pre-processing code needs to be run for this Payment Gateway

Parameters:

preProcessCode - the preProcessCode to set

getCreditCards

CreditCardIf[] getCreditCards()

Contains a list of available credit cards. Typically a list of credit cards stored by the payment gateway.

Returns:

the creditCards

setCreditCards

void setCreditCards(CreditCardIf[] creditCards)

Contains a list of available credit cards. Typically a list of credit cards stored by the payment gateway.

Parameters:

creditCards - the creditCards to set