public interface ICloverConnector
extends java.io.Serializable
Modifier and Type | Method and Description |
---|---|
void |
acceptPayment(com.clover.sdk.v3.payments.Payment payment)
If payment confirmation is required during a Sale, this method accepts the payment
|
void |
acceptSignature(VerifySignatureRequest request)
If signature is captured during a Sale, this method accepts the signature as entered
|
void |
addCloverConnectorListener(ICloverConnectorListener listener)
Adds a clover connection listener.
|
void |
auth(AuthRequest request)
Auth method to obtain an Auth payment that can be used as the payment
to call tipAdjust
|
void |
capturePreAuth(CapturePreAuthRequest request)
Capture a previous Auth.
|
void |
checkBalance(CheckBalanceRequest request)
Check the balance on a card, if card supports balance inquiry
|
void |
closeout(CloseoutRequest request)
Request a closeout of all orders.
|
void |
displayPaymentReceiptOptions(DisplayReceiptOptionsRequest request)
Deprecated.
|
void |
displayReceiptOptions(DisplayReceiptOptionsRequest request)
Display receipt options for a Credit, Refund, or Payment
|
void |
dispose()
Will dispose of the underlying connection to the device
|
void |
incrementPreAuth(IncrementPreauthRequest request)
Request to increase the amount of an existing pre-auth
|
void |
initializeConnection()
Initialize the CloverConnector's connection and start communication with the device.
|
void |
invokeInputOption(com.clover.remote.InputOption io)
Used to invoke user options on the mini such as "OK", "CANCEL", "DONE", etc.
|
void |
manualRefund(ManualRefundRequest request)
Manual refund method, aka "naked credit"
|
void |
openCashDrawer(OpenCashDrawerRequest request)
Request that the cash drawer connected to the device be opened.
|
void |
preAuth(PreAuthRequest request)
PreAuth method to obtain a Pre-Auth for a card
|
void |
print(PrintRequest request)
Request to print.
|
void |
readCardData(ReadCardDataRequest request)
Used to request card information.
|
void |
refundPayment(RefundPaymentRequest request)
Refund a specific payment
|
void |
registerForCustomerProvidedData(RegisterForCustomerProvidedDataRequest request)
Register an interest in receiving customer provided data.
|
void |
rejectPayment(com.clover.sdk.v3.payments.Payment payment,
com.clover.remote.Challenge challenge)
If payment confirmation is required during a Sale, this method rejects the payment
|
void |
rejectSignature(VerifySignatureRequest request)
If signature is captured during a Sale, this method rejects the signature as entered
|
void |
removeCloverConnectorListener(ICloverConnectorListener listener)
Removes a clover connector listener.
|
void |
removeDisplayOrder(com.clover.remote.order.DisplayOrder order)
Remove the DisplayOrder from the device.
|
void |
requestSignature(SignatureRequest request)
Launch customer facing signature screen to collect a signature
|
void |
requestTip(TipRequest request)
Launch customer facing tip screen to request a tip amount
|
void |
resetDevice()
Used to reset the device if it gets in an invalid state from POS perspective.
|
void |
retrieveDeviceStatus(RetrieveDeviceStatusRequest request)
Send a message requesting the current status of the device.
|
void |
retrievePayment(RetrievePaymentRequest request)
Sends a request to get a payment.
|
void |
retrievePendingPayments()
Used to request a list of pending payments that have been taken offline, but
haven't processed yet.
|
void |
retrievePrinters(RetrievePrintersRequest request)
Request to retrieve available printers.
|
void |
retrievePrintJobStatus(PrintJobStatusRequest request)
Request the status of a given print job
|
void |
sale(SaleRequest request)
Sale method, aka "purchase"
|
void |
sendDebugLog(java.lang.String message)
Sends request to the clover device to send the log to the clover server
|
void |
sendMessageToActivity(MessageToActivity request)
Send a message to a running custom activity on the Clover device
|
void |
setCustomerInfo(SetCustomerInfoRequest request) |
void |
showDisplayOrder(com.clover.remote.order.DisplayOrder order)
Show the DisplayOrder on the device.
|
void |
showMessage(java.lang.String message)
Show a message on the Clover Mini screen
|
void |
showThankYouScreen()
Show the thank you screen on the device
|
void |
showWelcomeScreen()
Return the device to the Welcome Screen
|
void |
startCustomActivity(CustomActivityRequest request)
Request to start a Custom Activity on the Clover device
|
void |
tipAdjustAuth(TipAdjustAuthRequest request)
Adjust the tip for a previous Auth.
|
void |
vaultCard(java.lang.Integer cardEntryMethods)
Vault card information.
|
void |
voidPayment(VoidPaymentRequest request)
Void a transaction, given a previously used order ID and/or payment ID
|
void |
voidPaymentRefund(VoidPaymentRefundRequest request)
Refund a specific payment
|
void initializeConnection()
void addCloverConnectorListener(ICloverConnectorListener listener)
listener
- The connection listener.void removeCloverConnectorListener(ICloverConnectorListener listener)
listener
- The connection listener.void sale(SaleRequest request)
request
- A SaleRequest object containing basic information needed for the transactionvoid acceptSignature(VerifySignatureRequest request)
request
- Accepted requestvoid rejectSignature(VerifySignatureRequest request)
request
- Rejected requestvoid acceptPayment(com.clover.sdk.v3.payments.Payment payment)
payment
- Payment to acceptvoid rejectPayment(com.clover.sdk.v3.payments.Payment payment, com.clover.remote.Challenge challenge)
payment
- Payment to rejectchallenge
- The challenge which resulted in payment rejectionvoid auth(AuthRequest request)
request
- The request detailsvoid preAuth(PreAuthRequest request)
request
- The request detailsvoid capturePreAuth(CapturePreAuthRequest request)
request
- The request detailsvoid incrementPreAuth(IncrementPreauthRequest request)
request
- The request detailsvoid tipAdjustAuth(TipAdjustAuthRequest request)
request
- The request detailsvoid voidPayment(VoidPaymentRequest request)
request
- The request detailsvoid refundPayment(RefundPaymentRequest request)
request
- The request detailsvoid manualRefund(ManualRefundRequest request)
request
- The request detailsvoid vaultCard(java.lang.Integer cardEntryMethods)
cardEntryMethods
- The card entry methods allowed to capture the payment token. null will provide default valuesvoid closeout(CloseoutRequest request)
request
- The request detailsvoid print(PrintRequest request)
request
- The request details: info and content needed to printvoid retrievePrinters(RetrievePrintersRequest request)
request
- object that contains additional information to be applied during the requestvoid retrievePrintJobStatus(PrintJobStatusRequest request)
request
- object defining the print job to be queriedvoid openCashDrawer(OpenCashDrawerRequest request)
request
- object defining the reason the cash drawer is being opened, and an optional device identifiervoid showMessage(java.lang.String message)
message
- The message to displayvoid sendDebugLog(java.lang.String message)
message
- The message to displayvoid showWelcomeScreen()
void showThankYouScreen()
@Deprecated void displayPaymentReceiptOptions(DisplayReceiptOptionsRequest request)
request
- The request detailsvoid showDisplayOrder(com.clover.remote.order.DisplayOrder order)
order
- The order to displayvoid removeDisplayOrder(com.clover.remote.order.DisplayOrder order)
order
- The order to removevoid dispose()
void invokeInputOption(com.clover.remote.InputOption io)
io
- The option to invokevoid resetDevice()
void retrievePendingPayments()
void readCardData(ReadCardDataRequest request)
request
- The request detailsvoid sendMessageToActivity(MessageToActivity request)
request
- The request detailsvoid startCustomActivity(CustomActivityRequest request)
request
- The request detailsvoid retrieveDeviceStatus(RetrieveDeviceStatusRequest request)
request
- The request detailsvoid retrievePayment(RetrievePaymentRequest request)
request
- The request detailsvoid voidPaymentRefund(VoidPaymentRefundRequest request)
request
- The request detailsvoid displayReceiptOptions(DisplayReceiptOptionsRequest request)
request
- The request detailsvoid registerForCustomerProvidedData(RegisterForCustomerProvidedDataRequest request)
void setCustomerInfo(SetCustomerInfoRequest request)
request
- void checkBalance(CheckBalanceRequest request)
request
- void requestSignature(SignatureRequest request)
request
- void requestTip(TipRequest request)
request
-