com.clover.remote.client.messages

Class SaleRequest

java.lang.Object

com.clover.remote.client.messages.BaseRequest

com.clover.remote.client.messages.TransactionRequest

com.clover.remote.client.messages.SaleRequest

public class SaleRequest
extends TransactionRequest

Request object for requesting a sale transaction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SaleRequest.TipMode Enumeration for indicating the mode of acquiring a tip

Constructor Summary

Constructors

Constructor and Description
SaleRequest(long amount, java.lang.String externalId) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAllowOfflinePayment() Get the field value
java.lang.Boolean	getApproveOfflinePaymentWithoutPrompt() Get the field value
java.lang.Boolean	getDisableCashback() Get the field value
java.lang.Boolean	getDisableTipOnScreen() Get the field value
java.lang.Boolean	getForceOfflinePayment() Get the field value
java.lang.Long	getTaxAmount() Get the field value
java.lang.Long	getTipAmount() Get the field value
SaleRequest.TipMode	getTipMode() Get the field value
java.lang.Long	getTippableAmount() Get the field value
com.clover.common2.payments.PayIntent.TransactionType	getType() Get the field value
void	setAllowOfflinePayment(java.lang.Boolean allowOfflinePayment) Set the field value
void	setApproveOfflinePaymentWithoutPrompt(java.lang.Boolean approveOfflinePaymentWithoutPrompt) Set the field value
void	setDisableCashback(java.lang.Boolean disableCashback) Set the field value
void	setDisableTipOnScreen(java.lang.Boolean disableTipOnScreen) Set the field value
void	setForceOfflinePayment(java.lang.Boolean forceOfflinePayment) Set the field value
void	setTaxAmount(java.lang.Long taxAmount) Set the field value
void	setTipAmount(java.lang.Long tipAmount) Set the field value
void	setTipMode(SaleRequest.TipMode tipMode) Set the field value
void	setTippableAmount(java.lang.Long tippableAmount) Set the field value

Methods inherited from class com.clover.remote.client.messages.TransactionRequest

getAmount, getAutoAcceptPaymentConfirmations, getAutoAcceptSignature, getCardEntryMethods, getCardNotPresent, getDisableDuplicateChecking, getDisablePrinting, getDisableReceiptSelection, getDisableRestartTransactionOnFail, getExternalId, getSignatureEntryLocation, getSignatureThreshold, getVaultedCard, setAmount, setAutoAcceptPaymentConfirmations, setAutoAcceptSignature, setCardEntryMethods, setCardNotPresent, setDisableDuplicateChecking, setDisablePrinting, setDisableReceiptSelection, setDisableRestartTransactionOnFail, setExternalId, setSignatureEntryLocation, setSignatureThreshold, setVaultedCard

Methods inherited from class java.lang.Object

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

Constructor Detail

SaleRequest

public SaleRequest(long amount,
                   java.lang.String externalId)

Constructor

Parameters:

amount - The amount of the transaction. This includes amount, tax, service charges, etc. except the tip

externalId - An id assigned by the POS that can be used to track a payment through the Clover system

Method Detail

setTippableAmount

public void setTippableAmount(java.lang.Long tippableAmount)

Set the field value

Parameters:

tippableAmount - The total amount used when calculating tips

getTippableAmount

public java.lang.Long getTippableAmount()

Get the field value

Returns:

The total amount used when calculating tips

setTipAmount

public void setTipAmount(java.lang.Long tipAmount)

Set the field value

Parameters:

tipAmount - Included tip

getTipAmount

public java.lang.Long getTipAmount()

Get the field value

Returns:

Included tip

setDisableCashback

public void setDisableCashback(java.lang.Boolean disableCashback)

Set the field value

Parameters:

disableCashback - If true, do not allow cash back

getDisableCashback

public java.lang.Boolean getDisableCashback()

Get the field value

Returns:

If true, do not allow cash back

setDisableTipOnScreen

public void setDisableTipOnScreen(java.lang.Boolean disableTipOnScreen)

Set the field value

Parameters:

disableTipOnScreen - If true, the tip screen will not be displayed on the device, even if the merchant is configured for tips on screen

getDisableTipOnScreen

public java.lang.Boolean getDisableTipOnScreen()

Get the field value

Returns:

If true, the tip screen will not be displayed on the device, even if the merchant is configured for tips on screen

setTaxAmount

public void setTaxAmount(java.lang.Long taxAmount)

Set the field value

Parameters:

taxAmount - Amount paid in taxes

getTaxAmount

public java.lang.Long getTaxAmount()

Get the field value

Returns:

Amount paid in tips

setAllowOfflinePayment

public void setAllowOfflinePayment(java.lang.Boolean allowOfflinePayment)

Set the field value

Parameters:

allowOfflinePayment - If true then offline payments can be accepted

getAllowOfflinePayment

public java.lang.Boolean getAllowOfflinePayment()

Get the field value

Returns:

If true then offline payments can be accepted

setForceOfflinePayment

public void setForceOfflinePayment(java.lang.Boolean forceOfflinePayment)

Set the field value

Parameters:

forceOfflinePayment - If true then the payment will be taken offline

getForceOfflinePayment

public java.lang.Boolean getForceOfflinePayment()

Get the field value

Returns:

If true then the payment will be taken offline

setApproveOfflinePaymentWithoutPrompt

public void setApproveOfflinePaymentWithoutPrompt(java.lang.Boolean approveOfflinePaymentWithoutPrompt)

Set the field value

Parameters:

approveOfflinePaymentWithoutPrompt - If true then offline payments will be approved without a prompt

getApproveOfflinePaymentWithoutPrompt

public java.lang.Boolean getApproveOfflinePaymentWithoutPrompt()

Get the field value

Returns:

If true then offline payments will be approved without a prompt

getType

public com.clover.common2.payments.PayIntent.TransactionType getType()

Description copied from class: TransactionRequest

Get the field value

Specified by:

getType in class TransactionRequest

Returns:

The type of the transaction.

setTipMode

public void setTipMode(SaleRequest.TipMode tipMode)

Set the field value

Parameters:

tipMode - The tip mode settings overrides

getTipMode

public SaleRequest.TipMode getTipMode()

Get the field value

Returns:

The tip mode settings overrides