se.westpay.posapplib

Class TransactionResponse

java.lang.Object

se.westpay.posapplib.GenericResponse

se.westpay.posapplib.TransactionResponse

Direct Known Subclasses:

CashAdvanceResponse, PurchaseResponse, RefundResponse

public class TransactionResponse
extends GenericResponse

Represents a transaction response.

See Also:

PurchaseResponse, RefundResponse, CashAdvanceResponse

Constructor Summary

Constructors

Constructor and Description
TransactionResponse() Constructor.
TransactionResponse(TransactionError error, java.lang.String errorMessage, java.lang.String saleId, java.lang.String transactionId, int currencyId, long totalAmount, java.lang.String merchantReceipt, java.lang.String cardholderReceipt) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCardholderReceipt()
int	getCurrencyId()
DenialReasons	getDenialReason()
TransactionError	getError()
java.lang.String	getMerchantReceipt()
PaymentData	getPaymentDetails()
java.lang.String	getSaleId()
java.lang.String	getTerminalId()
long	getTotalAmount()
java.lang.String	getTransactionId()
java.util.Date	getTransactionTime()
void	setCardholderReceipt(java.lang.String cardholderReceipt)
void	setCurrencyId(int value)
void	setDenialReason(DenialReasons value) > * @param value The reason for declining the transaction.
void	setError(TransactionError value)
void	setMerchantReceipt(java.lang.String merchantReceipt)
void	setPaymentDetails(PaymentData paymentDetails)
void	setSaleId(java.lang.String value)
void	setTerminalId(java.lang.String value)
void	setTotalAmount(long value)
void	setTransactionId(java.lang.String value)
void	setTransactionTime(java.util.Date transactionTime)

Methods inherited from class se.westpay.posapplib.GenericResponse

getErrorMessage, isSuccess, setErrorMessage, setSuccess

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransactionResponse

public TransactionResponse()

Constructor.

TransactionResponse

public TransactionResponse(TransactionError error,
                           java.lang.String errorMessage,
                           java.lang.String saleId,
                           java.lang.String transactionId,
                           int currencyId,
                           long totalAmount,
                           java.lang.String merchantReceipt,
                           java.lang.String cardholderReceipt)

Constructor.

Parameters:

error - The error code of the transaction.

errorMessage - A diagnostic error message, if the transaction failed.

saleId - The sail id from the transaction request.

transactionId - The transaction reference number.

currencyId - The currency used in the transaction.

totalAmount - The total authorised amount of the transaction.

merchantReceipt - The preformatted merchant receipt.

cardholderReceipt - The preformatted card holder receipt.

Method Detail

getCardholderReceipt

public java.lang.String getCardholderReceipt()

Returns:

A preformatted receipt for the customer/card holder. Empty or null if no receipt is available.

setCardholderReceipt

public void setCardholderReceipt(java.lang.String cardholderReceipt)

Parameters:

cardholderReceipt - The preformatted card holder receipt.

getDenialReason

public DenialReasons getDenialReason()

Returns:

The reason for declining the transaction, if applicable.

setDenialReason

public void setDenialReason(DenialReasons value)

> * @param value The reason for declining the transaction.

getMerchantReceipt

public java.lang.String getMerchantReceipt()

Returns:

A preformatted receipt for the merchant/cashier. Empty or null if no receipt is available.

setMerchantReceipt

public void setMerchantReceipt(java.lang.String merchantReceipt)

Parameters:

merchantReceipt - The preformatted merchant receipt.

getError

public TransactionError getError()

Returns:

An error code for the transaction. If the transaction was successful, then TransactionError.NONE is returned.

See Also:

GenericResponse.isSuccess()

setError

public void setError(TransactionError value)

Parameters:

value - The transaction error code.

getSaleId

public java.lang.String getSaleId()

Returns:

The sale id that was given in the transaction request.

setSaleId

public void setSaleId(java.lang.String value)

Parameters:

value - The sale id from the transaction request.

getTerminalId

public java.lang.String getTerminalId()

Returns:

The terminal id used in the transaction.

setTerminalId

public void setTerminalId(java.lang.String value)

Parameters:

value - The terminal id.

getTransactionId

public java.lang.String getTransactionId()

Returns:

The transaction reference id. This reference number is generated by the payment application and can used to identify this particular transaction afterwards.

setTransactionId

public void setTransactionId(java.lang.String value)

Parameters:

value - The transaction reference number.

getCurrencyId

public int getCurrencyId()

Returns:

int The currency that was used in the transaction. The currency is specified using an ISO 4217 3-digit code.

setCurrencyId

public void setCurrencyId(int value)

Parameters:

value - The currency id.

getTotalAmount

public long getTotalAmount()

Returns:

The total amount that was authorised in the transaction, including cash back, and tipping. The amount is specified in the small units of the transaction currency.

setTotalAmount

public void setTotalAmount(long value)

Parameters:

value - The total authorised amount.

getPaymentDetails

public PaymentData getPaymentDetails()

Returns:

Details about the purchase.

setPaymentDetails

public void setPaymentDetails(PaymentData paymentDetails)

Parameters:

paymentDetails - Details about the purchase.

getTransactionTime

public java.util.Date getTransactionTime()

Returns:

The time when the transaction was performed.

setTransactionTime

public void setTransactionTime(java.util.Date transactionTime)

Parameters:

transactionTime - The time when the transaction was performed.