com.konakart.appif
Interface IpnHistoryIf

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

int	getCustomerId()
java.util.Calendar	getDateAdded()
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
void	setCustomerId(int customerId)
void	setDateAdded(java.util.Calendar dateAdded)
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

Method Detail

getGatewayFullResponse

java.lang.String getGatewayFullResponse()

The full response received by the payment gateway. Format is normally paramName1=paramValue1¶mName2=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¶mName2=paramValue2& etc.)

Parameters:

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 -

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 -

getId

int getId()

Id

Returns:

Return the Id

setId

void setId(int id)

Id

Parameters:

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 -

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 -

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 -

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 -

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.