com.clover.remote.client.messages

Class SaleRequest

java.lang.Object

com.clover.remote.client.messages.BaseRequest

com.clover.remote.client.messages.BaseTransactionRequest

com.clover.remote.client.messages.TransactionRequest

com.clover.remote.client.messages.SaleRequest

public class SaleRequest
extends TransactionRequest

Request object for requesting a sale transaction.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getTipAmount() Get the field value
TipMode	getTipMode() Get the field value
void	setTipAmount(java.lang.Long tipAmount) Set the field value
void	setTipMode(TipMode tipMode) Set the field value
void	setTipSuggestions(com.clover.sdk.v3.merchant.TipSuggestion tipSuggestion1, com.clover.sdk.v3.merchant.TipSuggestion tipSuggestion2, com.clover.sdk.v3.merchant.TipSuggestion tipSuggestion3, com.clover.sdk.v3.merchant.TipSuggestion tipSuggestion4) Set the field value

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

getAllowOfflinePayment, getApproveOfflinePaymentWithoutPrompt, getAutoAcceptSignature, getDisableCashback, getForceOfflinePayment, getSignatureEntryLocation, getSignatureThreshold, getTaxAmount, getTippableAmount, getTipSuggestions, getType, setAllowOfflinePayment, setApproveOfflinePaymentWithoutPrompt, setAutoAcceptSignature, setDisableCashback, setForceOfflinePayment, setSignatureEntryLocation, setSignatureThreshold, setTaxAmount, setTippableAmount, setTipSuggestions

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

getAmount, getAutoAcceptPaymentConfirmations, getCardEntryMethods, getCardNotPresent, getDisableDuplicateChecking, getDisablePrinting, getDisableReceiptSelection, getDisableRestartTransactionOnFail, getExternalId, getExternalReferenceId, getExtras, getRegionalExtras, getVaultedCard, setAmount, setAutoAcceptPaymentConfirmations, setCardEntryMethods, setCardNotPresent, setDisableDuplicateChecking, setDisablePrinting, setDisableReceiptSelection, setDisableRestartTransactionOnFail, setExternalId, setExternalReferenceId, setExtras, setRegionalExtras, 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

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

setTipMode

public void setTipMode(TipMode tipMode)

Set the field value

Parameters:

tipMode - The tip mode settings overrides

getTipMode

public TipMode getTipMode()

Get the field value

Returns:

The tip mode settings overrides

setTipSuggestions

public void setTipSuggestions(com.clover.sdk.v3.merchant.TipSuggestion tipSuggestion1,
                              com.clover.sdk.v3.merchant.TipSuggestion tipSuggestion2,
                              com.clover.sdk.v3.merchant.TipSuggestion tipSuggestion3,
                              com.clover.sdk.v3.merchant.TipSuggestion tipSuggestion4)

Set the field value

Parameters:

tipSuggestion1 - - 4 set the tip suggestions