ICloverConnectorListener

Called at the completion of a Sale() request. The SaleResponse contains a 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 may 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.

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.

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.

Called in response to a CapturePreAuth() request. Contains the new Amount and TipAmount if successful.

Called in response to an incrementPreAuth() call on the CloverConnector Returns the incremented pre-auth, if successful

Called in response to a tip adjustment for an Auth transaction. Contains the tipAmount if successful.

Called in response to a voidPayment() request. Contains a ResultCode and a Success boolean. If successful, the response will also contain the paymentId for the voided Payment.

Called in response to a RefundPayment() request. Contains a ResultCode and a Success boolean. The response to a successful transaction will contain the Refund. The Refund includes the original paymentId as a reference.

Called in response to a voidPaymentRefund() request. Contains a ResultCode and a Success boolean. The response to a successful transaction will contain the Refund. The Refund includes the original paymentId as a reference.

Called in response to a manualRefund() request. Contains a ResultCode and a Success boolean. If successful, the ManualRefundResponse will have a Credit object associated with the relevant Payment information.

Called in response to a Closeout() request.

Called when the Clover device requests verification for a user’s on-screen signature. The Payment and Signature will be passed in.

Called in response to a vaultCard() request. Contains a ResultCode and a Success boolean. If successful, the response will contain a VaultedCard object with a token value that’s unique for the card and merchant. The token can be used for future Sale() and Auth() requests.

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.

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.

Called when an error occurs while trying to send messages to the Clover device.

Called when the Clover device is initially connected, but not ready to communicate.

Called when the Clover device is ready to communicate and respond to requests.

Called when the Clover device is disconnected from the CloverConnector or not responding. Not called when the CloverConnector is manually disconnected via ‘dispose()’

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 that 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.

Called when a customer selects a tip amount on the Clover device’s screen.

Called when a user requests a paper receipt for a Manual Refund. Will only be called if disablePrinting = true on the ManualRefund() request.

Called when a user requests a paper receipt for a declined Manual Refund. Will only be called if disablePrinting = true on the ManualRefund() request.

Called when a user requests a paper receipt for a Payment. Will only be called if disablePrinting = true on the Sale(), Auth(), or PreAuth() request.

Called when a user requests a paper receipt for a declined Payment. Will only be called if disablePrinting = true on the Sale(), Auth(), or PreAuth() request.

Called when a user requests a merchant copy of a Payment receipt. Will only be called if disablePrinting = true on the Sale(), Auth(), or PreAuth() request.

Called when a user requests a paper receipt for a Payment Refund. Will only be called if disablePrinting = true on the Sale(), Auth(), PreAuth() or ManualRefund() request.

Called in response to a retrievePrinters() request.

Called in response to a retrievePrintJobStatus() request.

Called in response to a retrievePendingPayment() request.

Called in response to a readCardData() request.

Called when a Custom Activity finishes normally.

Called in response to a ResetDevice() request.

Called whenever customer provided data is accrued via the Loyalty API. Call the registerForCustomerProvidedData to request that this message be called.

Called when a Custom Activity sends a message to the POS.

Called in response to a RetrievePayment() request.

Called in response to a RetrieveDeviceStatus() request.

Called in response to a request that results in an invalid kiosk flow transition

Called in response to a DisplayReceiptOptionsRequest