se.westpay.posapplib

Class TransactionRequest

java.lang.Object

se.westpay.posapplib.TransactionRequest

Direct Known Subclasses:

CashAdvanceRequest, PurchaseRequest, RefundRequest, ReversalRequest

public abstract class TransactionRequest
extends java.lang.Object

Contains the details of a new transaction. This class should not be used directly by the POS application. The POS application should instantiate one of the subclasses of this class when a transaction should be performed.

See Also:

PurchaseRequest, RefundRequest, CashAdvanceRequest, TransactionResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
	TransactionRequest() Constructor.
protected	TransactionRequest(int currencyId, long totalAmount) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getCurrencyId()
java.lang.Enum<PaymentFeatures>[]	getDisabledFeatures()
java.lang.String[]	getLoyaltyApplications()
java.lang.String	getPaymentMethod()
java.lang.String	getSaleId()
long	getTotalAmount()
void	setCurrencyId(int value)
void	setDisabledFeatures(java.lang.Enum<PaymentFeatures>[] features)
void	setLoyaltyApplications(java.lang.String[] applications)
void	setPaymentMethod(java.lang.String paymentMethod) Specifies that a specific payment method should be used in this transaction.
void	setSaleId(java.lang.String value)
void	setTotalAmount(long value)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionRequest

public TransactionRequest()

Constructor.

TransactionRequest

protected TransactionRequest(int currencyId,
                             long totalAmount)

Constructor.

Parameters:

currencyId - The preferred currency of the transaction.

totalAmount - The total amount of the transaction, in the small unit of the currency.

Method Detail

getCurrencyId

public final int getCurrencyId()

Returns:

The preferred currency of the transaction.

See Also:

https://en.wikipedia.org/wiki/ISO_4217

setCurrencyId

public final void setCurrencyId(int value)

Parameters:

value - The preferred currency of the transaction. This has to match the currency that is enabled in the payment application configuration.

The currency is specified using ISO 4217 3-digit codes. Some examples are:

• 208: DKK
• 578: NOK
• 752: SEK
• 978: EUR

See Also:

https://en.wikipedia.org/wiki/ISO_4217

getDisabledFeatures

public final java.lang.Enum<PaymentFeatures>[] getDisabledFeatures()

Returns:

The features that should be disabled for the transaction.

setDisabledFeatures

public final void setDisabledFeatures(java.lang.Enum<PaymentFeatures>[] features)

Parameters:

features - Zero or more features that should be disabled for the transaction.

Note! Some features rely on the terminal being configured for them, so they might not be enabled just being they are not disabled here.

getTotalAmount

public final long getTotalAmount()

Returns:

The total amount of the transaction.

setTotalAmount

public final void setTotalAmount(long value)

Parameters:

value - The total amount of the transaction. This amount should include all other amounts, like cashback, or tipping.

Note! The amount must be specified in the "small unit" of the currency. For example, for EUR the amount must be specified in cents, for SEK it must be specified in ören, and so on. So an amount of 12.50 EUR translates into 1250 cents.

getSaleId

public final java.lang.String getSaleId()

Returns:

The sale id of the transaction.

setSaleId

public final void setSaleId(java.lang.String value)

Parameters:

value - The sale id of the transaction. The sale id is something the POS application can use to correlate the transaction with its own transaction data. The payment application does not use this value for anything and will just repeat the value in the transaction response.

See Also:

TransactionResponse.getSaleId()

getLoyaltyApplications

public final java.lang.String[] getLoyaltyApplications()

Returns:

The list of accepted loyalty applications.

setLoyaltyApplications

public final void setLoyaltyApplications(java.lang.String[] applications)

Parameters:

applications - A list of names of loyalty applications that should be accepted during the transaction.

getPaymentMethod

public java.lang.String getPaymentMethod()

Returns:

Gets the requested payment method.

setPaymentMethod

public void setPaymentMethod(java.lang.String paymentMethod)

Specifies that a specific payment method should be used in this transaction.

If this is not set, then the terminal will let the user choose which payment method to use, based on which methods are available.

If the requested method is not available on the terminal, the transaction will fail.

To check which payment method was used in a transaction, get the payment details from TransactionResponse.getPaymentDetails().

Parameters:

paymentMethod - The name of the requested payment method, e.g. "swish", or "vipps".