Class: ICloverConnectorListener

remotepay.ICloverConnectorListener()

new ICloverConnectorListener()

Source:

Methods

(static) ICloverConnectorListener#onAuthResponse(response)

Called in response to an Auth() request. Note: An Auth transaction may come back as a final Sale, depending on the payment gateway. The AuthResponse has a boolean isAuth flag that indicates whether the Payment can still be tip-adjusted.
Parameters:
Name Type Description
response remotepay.AuthResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onCapturePreAuthResponse(response)

Called in response to a CapturePreAuth() request. Contains the new Amount and TipAmount if successful.
Parameters:
Name Type Description
response remotepay.CapturePreAuthResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onCheckBalanceResponse(response, response)

Called in response to a CheckBalanceRequest
Parameters:
Name Type Description
response
response remotepay.CheckBalanceResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onCloseoutResponse(response)

Called in response to a Closeout() request.
Parameters:
Name Type Description
response remotepay.CloseoutResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onConfirmPaymentRequest(request)

Called when the Clover device encounters a Challenge at the payment gateway and requires confirmation. A Challenge is triggered by a potential duplicate Payment (DUPLICATE_CHALLENGE) or an offline Payment (OFFLINE_CHALLENGE). The device sends a ConfirmPaymentRequest() asking the merchant to reply by sending either an AcceptPayment() or RejectPayment() call. Note: Duplicate Payment Challenges are raised when multiple Payments are made with the same card type and last four digits within the same hour. For this reason, we recommend that you do not programmatically call CloverConnector.RejectPayment() on all instances of DUPLICATE_CHALLENGE. For more information, see Working with Challenges.
Parameters:
Name Type Description
request remotepay.ConfirmPaymentRequest
Source:
Returns:
void

(static) ICloverConnectorListener#onCustomActivityResponse(response)

Called when a Custom Activity finishes normally.
Parameters:
Name Type Description
response remotepay.CustomActivityResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onCustomerProvidedData(response)

Called when customer information is provided from a loyalty service.
Parameters:
Name Type Description
response remotepay.CustomerProvidedDataEvent
Source:
Returns:
void

(static) ICloverConnectorListener#onDeviceActivityEnd(deviceEvent)

Called when the Clover device transitions away from a screen or activity. The CloverDeviceEvent passed in will contain an event type and description. Note: The start and end events are not guaranteed to process in order. The event type should be used to make sure these events are paired.
Parameters:
Name Type Description
deviceEvent remotepay.CloverDeviceEvent
Source:
Returns:
void

(static) ICloverConnectorListener#onDeviceActivityStart(deviceEvent)

Called when the Clover device transitions to a new screen or activity. The CloverDeviceEvent passed in will contain an event type, a description, and a list of available InputOptions.
Parameters:
Name Type Description
deviceEvent remotepay.CloverDeviceEvent
Source:
Returns:
void

(static) ICloverConnectorListener#onDeviceConnected()

Called when the Clover device is initially connected, but not ready to communicate.
Source:
Returns:
void

(static) ICloverConnectorListener#onDeviceDisconnected()

Called when the Clover device is disconnected from the CloverConnector or not responding.
Source:
Returns:
void

(static) ICloverConnectorListener#onDeviceError(deviceErrorEvent)

Called when an error occurs while trying to send messages to the Clover device.
Parameters:
Name Type Description
deviceErrorEvent remotepay.CloverDeviceErrorEvent
Source:
Returns:
void

(static) ICloverConnectorListener#onDeviceReady(merchantInfo)

Called when the Clover device is ready to communicate and respond to requests.
Parameters:
Name Type Description
merchantInfo remotepay.MerchantInfo
Source:
Returns:
void

(static) ICloverConnectorListener#onDisplayReceiptOptionsResponse(response, response)

Called in response to a DisplayReceiptOptionsRequest
Parameters:
Name Type Description
response
response remotepay.DisplayReceiptOptionsResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onIncrementPreAuthResponse(response)

Called in response to an incrementPreAuth() request. Contains the incremented PreAuth with the new authorized total, if successful.
Parameters:
Name Type Description
response remotepay.IncrementPreAuthResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onInvalidStateTransitionResponse(response, response)

Called in response to a request that results in an invalid kiosk flow transition
Parameters:
Name Type Description
response The response
response remotepay.InvalidStateTransitionResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onManualRefundResponse(response)

Called in response to a manualRefund() request. Contains a {@see com.clover.remote.client.messages.ResultCode} and a Success boolean. If successful, the ManualRefundResponse will have a Credit object associated with the relevant Payment information.
Parameters:
Name Type Description
response remotepay.ManualRefundResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onMessageFromActivity(message)

Called when a Custom Activity sends a message to the POS.
Parameters:
Name Type Description
message remotepay.MessageFromActivity
Source:
Returns:
void

(static) ICloverConnectorListener#onPreAuthResponse(response)

Called in response to a PreAuth() request. Note: The boolean isPreAuth flag in the PreAuthResponse indicates whether CapturePreAuth() can be called for the returned Payment. If the isPreAuth flag is false and the isAuth flag is true, then the payment gateway coerced the PreAuth() request to an Auth. The payment will need to be voided or it will be automatically captured at closeout.
Parameters:
Name Type Description
response remotepay.PreAuthResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onPrintJobStatusResponse(response)

Called in response to a retrievePrintJobStatus() request.
Parameters:
Name Type Description
response remotepay.PrintJobStatusResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onPrintManualRefundDeclineReceipt(message, message)

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined ManualRefund
Parameters:
Name Type Description
message The message
message remotepay.PrintManualRefundDeclineReceiptMessage
Source:
Returns:
void

(static) ICloverConnectorListener#onPrintManualRefundReceipt(message, message)

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a ManualRefund
Parameters:
Name Type Description
message The message
message remotepay.PrintManualRefundReceiptMessage
Source:
Returns:
void

(static) ICloverConnectorListener#onPrintPaymentDeclineReceipt(message, message)

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined payment
Parameters:
Name Type Description
message The message
message remotepay.PrintPaymentDeclineReceiptMessage
Source:
Returns:
void

(static) ICloverConnectorListener#onPrintPaymentMerchantCopyReceipt(message, message)

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a merchant copy of a payment receipt
Parameters:
Name Type Description
message The message
message remotepay.PrintPaymentMerchantCopyReceiptMessage
Source:
Returns:
void

(static) ICloverConnectorListener#onPrintPaymentReceipt(message, message)

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment
Parameters:
Name Type Description
message The message
message remotepay.PrintPaymentReceiptMessage
Source:
Returns:
void

(static) ICloverConnectorListener#onPrintRefundPaymentReceipt(message, message)

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment refund
Parameters:
Name Type Description
message The message
message remotepay.PrintRefundPaymentReceiptMessage
Source:
Returns:
void

(static) ICloverConnectorListener#onReadCardDataResponse(response)

Called in response to a readCardData() request. Contains card information (specifically Track 1 and Track 2 card data).
Parameters:
Name Type Description
response remotepay.ReadCardDataResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onRefundPaymentResponse(response)

Called in response to a RefundPayment() request. Contains a {@see com.clover.remote.client.messages.ResultCode} and a Success boolean. The response to a successful transaction will contain the Refund, which includes the original paymentId as a reference.
Parameters:
Name Type Description
response remotepay.RefundPaymentResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onRequestSignatureResponse(response, response)

Called in response to a RequestSignatureRequest
Parameters:
Name Type Description
response
response remotepay.SignatureResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onRequestTipResponse(response, response)

Called in response to a TipRequest
Parameters:
Name Type Description
response
response remotepay.TipResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onResetDeviceResponse(response)

Called in response to a ResetDevice() request.
Parameters:
Name Type Description
response remotepay.ResetDeviceResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onRetrieveDeviceStatusResponse(response)

Called in response to a RetrieveDeviceStatus() request.
Parameters:
Name Type Description
response remotepay.RetrieveDeviceStatusResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onRetrievePaymentResponse(response)

Called in response to a RetrievePayment() request.
Parameters:
Name Type Description
response remotepay.RetrievePaymentResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onRetrievePendingPaymentsResponse(retrievePendingPaymentResponse)

Called in response to a retrievePendingPayment() request.
Parameters:
Name Type Description
retrievePendingPaymentResponse remotepay.RetrievePendingPaymentsResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onRetrievePrintersResponse(response)

Called in response to a retrievePrinters() request.
Parameters:
Name Type Description
response remotepay.RetrievePrintersResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onSaleResponse(response)

Called at the completion of a Sale() request. The SaleResponse contains a {@see com.clover.remote.client.messages.ResultCode} and a Success boolean. A successful Sale transaction will also have the Payment object, which can be for the full or partial amount of the Sale request. Note: A Sale transaction my come back as a tip-adjustable Auth, depending on the payment gateway. The SaleResponse has a boolean isSale flag that indicates whether the Sale is final, or will be finalized during closeout.
Parameters:
Name Type Description
response remotepay.SaleResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onTipAdded(tipAdded)

Called when a customer selects a tip amount on the Clover device's screen.
Parameters:
Name Type Description
tipAdded remotepay.TipAdded
Source:
Returns:
void

(static) ICloverConnectorListener#onTipAdjustAuthResponse(response)

Called in response to a tip adjustment for an Auth transaction. Contains the tipAmount if successful.
Parameters:
Name Type Description
response remotepay.TipAdjustAuthResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onVaultCardResponse(response)

Called in response to a vaultCard() request. Contains a {@see com.clover.remote.client.messages.ResultCode} and a Success boolean. If successful, the response will contain a VaultedCard object with a token that's unique for the card and merchant. The token can be used for future Sale() and Auth() requests.
Parameters:
Name Type Description
response remotepay.VaultCardResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onVerifySignatureRequest(request)

Called when the Clover device requests verification for a user's on-screen signature. The Payment and Signature will be passed in.
Parameters:
Name Type Description
request remotepay.VerifySignatureRequest
Source:
Returns:
void

(static) ICloverConnectorListener#onVoidPaymentRefundResponse(response)

Called in response to a void payment refund request.
Parameters:
Name Type Description
response remotepay.VoidPaymentRefundResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onVoidPaymentResponse(response)

Called in response to a voidPayment() request. Contains a {@see com.clover.remote.client.messages.ResultCode} and a Success boolean. If successful, the response will also contain the paymentId for the voided Payment.
Parameters:
Name Type Description
response remotepay.VoidPaymentResponse
Source:
Returns:
void