se.westpay.posapplib

Class PurchaseRequest

java.lang.Object

se.westpay.posapplib.TransactionRequest

se.westpay.posapplib.PurchaseRequest

public class PurchaseRequest
extends TransactionRequest

Represents a standard purchase request.

See Also:

PurchaseResponse

Constructor Summary

Constructors

Constructor and Description
PurchaseRequest() Constructor.
PurchaseRequest(int currencyId, long totalAmount) Constructor.

Method Summary

Modifier and Type	Method and Description
SkipTipOptions	getAllowSkipTip()
long	getCashBackAmount()
long	getMaximumTipAmount()
int	getMaximumTipPercent()
long	getTipAmount()
void	setAllowSkipTip(SkipTipOptions value)
void	setCashBackAmount(long value)
void	setMaximumTipAmount(long value)
void	setMaximumTipPercent(int value)
void	setTipAmount(long amount)

Methods inherited from class se.westpay.posapplib.TransactionRequest

getCurrencyId, getDisabledFeatures, getLoyaltyApplications, getPaymentMethod, getSaleId, getTotalAmount, setCurrencyId, setDisabledFeatures, setLoyaltyApplications, setPaymentMethod, setSaleId, setTotalAmount

Methods inherited from class java.lang.Object

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

Constructor Detail

PurchaseRequest

public PurchaseRequest()

Constructor.

PurchaseRequest

public PurchaseRequest(int currencyId,
                       long totalAmount)

Constructor.

Parameters:

currencyId - The preferred currency of the transaction.

totalAmount - The total amount of the transaction.

Method Detail

getCashBackAmount

public long getCashBackAmount()

Returns:

The cash back amount.

setCashBackAmount

public void setCashBackAmount(long value)

Parameters:

value - The cash back amount. This amount must be included in totalAmount, and specified in the small units of the currency.

getMaximumTipAmount

public long getMaximumTipAmount()

Returns:

The the maximum tip amount.

Since:

Version 1.7. Requires Westpay Payment Application 2.0.11, or later.

setMaximumTipAmount

public void setMaximumTipAmount(long value)

Parameters:

value - The maximum tip amount allowed. If this value is set, it overrides the maximum percent. The value must be the tip amount only, it should not include the main amount of the transaction.

If neither the maximum tip amount, nor the maximum tip percent, is set, then tipping is decided by how the payment application is configured.

If both maximum tip amount, and the maximum tip percent, is set to 0, then tipping is disabled, regardless of how the payment application is configured.

The maximum tip amount takes precedence over the maximum tip percent, so if both values are set, then the percent is ignored.

Since:

Version 1.7. Requires Westpay Payment Application 2.0.11, or later.

getMaximumTipPercent

public int getMaximumTipPercent()

Returns:

The the maximum tip percent.

Since:

Version 1.7. Requires Westpay Payment Application 2.0.11, or later.

setMaximumTipPercent

public void setMaximumTipPercent(int value)

Parameters:

value - The maximum tip amount allowed in percent of the main amount.

If a specific maximum amount has been specified (setMaximumTipAmount(long)) then the maximum percent is ignored.

If neither the maximum tip amount, nor the maximum tip percent, is set, then tipping is decided by how the payment application is configured.

If both maximum tip amount, and the maximum tip percent, is set to 0, then tipping is disabled, regardless of how the payment application is configured.

The maximum tip amount takes precedence over the maximum tip percent, so if both values are set, then the percent is ignored.

Since:

Version 1.7. Requires Westpay Payment Application 2.0.11, or later.

getAllowSkipTip

public SkipTipOptions getAllowSkipTip()

Returns:

Determines if the customer is allowed to skip tipping, or not.

Since:

Version 1.7. Requires Westpay Payment Application 2.0.11, or later.

setAllowSkipTip

public void setAllowSkipTip(SkipTipOptions value)

Parameters:

value - Determines if the customer is allowed to skip tipping, or not.

Since:

Version 1.7. Requires Westpay Payment Application 2.0.11, or later.

getTipAmount

public long getTipAmount()

Returns:

The tip amount, in the small units of the current currency.

Since:

Version 1.7.

setTipAmount

public void setTipAmount(long amount)

Parameters:

amount - A pre-determined tip amount, in the small units of the current currency.

If this is non-zero, then the tipping dialogue will be skipped automatically.

Since:

Version 1.7. Requires Westpay Payment Application 2.0.11, or later.