com.konakart.appif

Interface IpnHistoryIf

All Known Implementing Classes:

IpnHistory

public interface IpnHistoryIf

IPN stands for Instant Product Notification. It refers to the notification from a payment gateway either from a callback or from a response to a request made to the gateway. It contains the data received from the gateway response.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdminPaymentClass() The class that can be used to make further transactions later such as a capture or a credit
java.lang.String	getCustom1()
java.math.BigDecimal	getCustom1Dec()
java.lang.String	getCustom2()
java.math.BigDecimal	getCustom2Dec()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
int	getCustomerId()
java.util.Calendar	getDateAdded()
java.lang.String	getGatewayCaptureId() The id that may be used to perform a capture operation
java.lang.String	getGatewayCreditId() The id that may be used to refund a customer
java.lang.String	getGatewayFullResponse() The full response received by the payment gateway.
java.lang.String	getGatewayResult() The result string returned by the payment gateway (i.e.
java.lang.String	getGatewayTransactionId() The transaction id returned by the payment gateway
int	getId() Id
java.lang.String	getKonakartResultDescription() A description of the KonaKart result.
int	getKonakartResultId() A KonaKart result.
java.lang.String	getModuleCode() The code of the payment module (i.e.
int	getOrderId() The order id for the payment
int	getSubscriptionId() The id of the subscription object if this payment is part of a recurring billing scenario
java.math.BigDecimal	getTxAmount() The amount of the transaction.
java.lang.String	getTxType() The type of transaction.
void	setAdminPaymentClass(java.lang.String adminPaymentClass) The class that can be used to make further transactions later such as a capture or a credit
void	setCustom1(java.lang.String custom1)
void	setCustom1Dec(java.math.BigDecimal custom1Dec)
void	setCustom2(java.lang.String custom2)
void	setCustom2Dec(java.math.BigDecimal custom2Dec)
void	setCustom3(java.lang.String custom3)
void	setCustom4(java.lang.String custom4)
void	setCustomerId(int customerId)
void	setDateAdded(java.util.Calendar dateAdded)
void	setGatewayCaptureId(java.lang.String gatewayCaptureId) The id that may be used to perform a capture operation
void	setGatewayCreditId(java.lang.String gatewayCreditId) The id that may be used to refund a customer
void	setGatewayFullResponse(java.lang.String gatewayFullResponse) The full response received by the payment gateway.
void	setGatewayResult(java.lang.String gatewayResult) The result string returned by the payment gateway (i.e.
void	setGatewayTransactionId(java.lang.String gatewayTransactionId) The transaction id returned by the payment gateway
void	setId(int id) Id
void	setKonakartResultDescription(java.lang.String konakartResultDescription) A description of the KonaKart result.
void	setKonakartResultId(int konakartResultId) A KonaKart result.
void	setModuleCode(java.lang.String moduleCode) The code of the payment module (i.e.
void	setOrderId(int orderId) The order id for the payment
void	setSubscriptionId(int subscriptionId) The id of the subscription object if this payment is part of a recurring billing scenario
void	setTxAmount(java.math.BigDecimal txAmount) The amount of the transaction.
void	setTxType(java.lang.String txType) The type of transaction.

Method Detail

getGatewayFullResponse

java.lang.String getGatewayFullResponse()

The full response received by the payment gateway. Format is normally: paramName1=paramValue1&paramName2=paramValue2& etc.

Returns:

Return the GatewayFullResponse

setGatewayFullResponse

void setGatewayFullResponse(java.lang.String gatewayFullResponse)

The full response received by the payment gateway. Format is: paramName1=paramValue1&paramName2=paramValue2& etc.

Parameters:

gatewayFullResponse - the gatewayFullResponse

getGatewayResult

java.lang.String getGatewayResult()

The result string returned by the payment gateway (i.e. approved or declined)

Returns:

Return the GatewayResult

setGatewayResult

void setGatewayResult(java.lang.String gatewayResult)

The result string returned by the payment gateway (i.e. approved or declined)

Parameters:

gatewayResult - the gatewayResult

getGatewayTransactionId

java.lang.String getGatewayTransactionId()

The transaction id returned by the payment gateway

Returns:

Return the GatewayTransactionId

setGatewayTransactionId

void setGatewayTransactionId(java.lang.String gatewayTransactionId)

The transaction id returned by the payment gateway

Parameters:

gatewayTransactionId - the gatewayTransactionId

getGatewayCaptureId

java.lang.String getGatewayCaptureId()

The id that may be used to perform a capture operation

Returns:

the gatewayCaptureId

setGatewayCaptureId

void setGatewayCaptureId(java.lang.String gatewayCaptureId)

The id that may be used to perform a capture operation

Parameters:

gatewayCaptureId - the gatewayCaptureId to set

getGatewayCreditId

java.lang.String getGatewayCreditId()

The id that may be used to refund a customer

Returns:

the gatewayCreditId

setGatewayCreditId

void setGatewayCreditId(java.lang.String gatewayCreditId)

The id that may be used to refund a customer

Parameters:

gatewayCreditId - the gatewayCreditId to set

getId

int getId()

Id

Returns:

Return the Id

setId

void setId(int id)

Id

Parameters:

id - the id

getKonakartResultDescription

java.lang.String getKonakartResultDescription()

A description of the KonaKart result. The KonaKart results determines whether the transaction was successful even though payment authorisation may have been declined.

Returns:

Return the KonakartResultDescription

setKonakartResultDescription

void setKonakartResultDescription(java.lang.String konakartResultDescription)

A description of the KonaKart result. The KonaKart results determines whether the transaction was successful even though payment authorisation may have been declined.

Parameters:

konakartResultDescription - the konakartResultDescription

getKonakartResultId

int getKonakartResultId()

A KonaKart result. Set to zero if all is OK. A negative number if something has gone wrong. i.e. We may not be able to associate a callback with an order.

Returns:

Return the KonakartResultId

setKonakartResultId

void setKonakartResultId(int konakartResultId)

A KonaKart result. Set to zero if all is OK. A negative number if something has gone wrong. i.e. We may not be able to associate a callback with an order.

Parameters:

konakartResultId - the konakartResultId

getModuleCode

java.lang.String getModuleCode()

The code of the payment module (i.e. paypal, chronopay etc.

Returns:

Return the ModuleCode

setModuleCode

void setModuleCode(java.lang.String moduleCode)

The code of the payment module (i.e. paypal, chronopay etc.

Parameters:

moduleCode - the moduleCode

getOrderId

int getOrderId()

The order id for the payment

Returns:

Return the OrderId

setOrderId

void setOrderId(int orderId)

The order id for the payment

Parameters:

orderId - the orderId

getDateAdded

java.util.Calendar getDateAdded()

Returns:

Returns the dateAdded.

setDateAdded

void setDateAdded(java.util.Calendar dateAdded)

Parameters:

dateAdded - The dateAdded to set.

getCustomerId

int getCustomerId()

Returns:

Returns the customerId.

setCustomerId

void setCustomerId(int customerId)

Parameters:

customerId - The customerId to set.

getSubscriptionId

int getSubscriptionId()

The id of the subscription object if this payment is part of a recurring billing scenario

Returns:

the subscriptionId

setSubscriptionId

void setSubscriptionId(int subscriptionId)

The id of the subscription object if this payment is part of a recurring billing scenario

Parameters:

subscriptionId - the subscriptionId to set

getTxAmount

java.math.BigDecimal getTxAmount()

The amount of the transaction. Useful in cases where it may be different to the amount of the order.

Returns:

the txAmount

setTxAmount

void setTxAmount(java.math.BigDecimal txAmount)

The amount of the transaction. Useful in cases where it may be different to the amount of the order.

Parameters:

txAmount - the txAmount to set

getTxType

java.lang.String getTxType()

The type of transaction. i.e. Authorization or Capture

Returns:

the txType

getAdminPaymentClass

java.lang.String getAdminPaymentClass()

The class that can be used to make further transactions later such as a capture or a credit

Returns:

the adminPaymentClass

setAdminPaymentClass

void setAdminPaymentClass(java.lang.String adminPaymentClass)

The class that can be used to make further transactions later such as a capture or a credit

Parameters:

adminPaymentClass - the adminPaymentClass to set

setTxType

void setTxType(java.lang.String txType)

The type of transaction. i.e. Authorization or Capture

Parameters:

txType - the txType to set

getCustom1

java.lang.String getCustom1()

Returns:

the custom1

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - the custom1 to set

getCustom2

java.lang.String getCustom2()

Returns:

the custom2

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - the custom2 to set

getCustom3

java.lang.String getCustom3()

Returns:

the custom3

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - the custom3 to set

getCustom4

java.lang.String getCustom4()

Returns:

the custom4

setCustom4

void setCustom4(java.lang.String custom4)

Parameters:

custom4 - the custom4 to set

getCustom1Dec

java.math.BigDecimal getCustom1Dec()

Returns:

the custom1Dec

setCustom1Dec

void setCustom1Dec(java.math.BigDecimal custom1Dec)

Parameters:

custom1Dec - the custom1Dec to set

getCustom2Dec

java.math.BigDecimal getCustom2Dec()

Returns:

the custom2Dec

setCustom2Dec

void setCustom2Dec(java.math.BigDecimal custom2Dec)

Parameters:

custom2Dec - the custom2Dec to set