Class: ICloverConnectorListener

remotepay.ICloverConnectorListener

new ICloverConnectorListener()

Source:

Methods

(static) ICloverConnectorListener#onAuthResponse(response)

Will be called, one or more times, at the completion of an auth transaction request, with the same results as a SaleResponse. Note: An auth transaction may come back as a final sale, depending on the payment gateway. The AuthResponse has a boolean isAuth to determine if it can still be tip adjusted.
Parameters:
Name Type Description
response remotepay.AuthResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onCapturePreAuthResponse(response)

Will be called after a capture pre-auth request and contains the new Amount and TipAmount if successful
Parameters:
Name Type Description
response remotepay.CapturePreAuthResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onCloseoutResponse(response)

Can get called multiple times at various stages. The Reason will contain information about what was successful or what failed.
Parameters:
Name Type Description
response remotepay.CloseoutResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onConfirmPaymentRequest(request)

Will be called, passing in the Payment, if some type of confirmation is required to accept a payment. To accept and continue, CloverConnector.acceptPayment should be called, passing in the payment from the request. To reject the payment, CloverConnector.rejectpayment should be called, passing in one of the VoidReason objects from the corresponding Challenge in the ConfirmPaymentRequest.
Parameters:
Name Type Description
request remotepay.ConfirmPaymentRequest
Source:
Returns:
void

(static) ICloverConnectorListener#onConnected()

Called when the device connects
Source:
Returns:
void

(static) ICloverConnectorListener#onDeviceActivityEnd(deviceEvent)

Will be called when leaving a screen or activity on the Mini. The CloverDeviceEvent passed in will contain an event type and description. Note: The Start and End events are not guaranteed to process in order, so the event type should be used to make sure the start and end events are paired.
Parameters:
Name Type Description
deviceEvent remotepay.CloverDeviceEvent
Source:
Returns:
void

(static) ICloverConnectorListener#onDeviceActivityStart(deviceEvent)

Will be called when a screen or activity changes on the Mini. 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#onDeviceError(deviceErrorEvent)

Will be called when an error occurs when trying to send messages to the device
Parameters:
Name Type Description
deviceErrorEvent remotepay.CloverDeviceErrorEvent
Source:
Returns:
void

(static) ICloverConnectorListener#onDisconnected()

Called when the device disconnects
Source:
Returns:
void

(static) ICloverConnectorListener#onManualRefundResponse(response)

Will be called at the completion of a manual refund request, with either a SUCCESS or CANCEL code. 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#onPreAuthResponse(response)

Will be called, one or more times, at the complete of a pre-auth transaction request, with the same results as a SaleResponse. Note: The isPreAuth boolean on the PreAuthResponse verifies if CapturePreAuth can be called for the returned payment.
Parameters:
Name Type Description
response remotepay.PreAuthResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onReadCardDataResponse(response) → {Null}

Called in response to a readCardData(...) request
Parameters:
Name Type Description
response remotepay.ReadCardDataResponse
Source:
Returns:
Type
Null

(static) ICloverConnectorListener#onReady(merchantInfo)

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

(static) ICloverConnectorListener#onRefundPaymentResponse(response)

Will be called after a refund payment request and contains the Refund if successful. The Refund contains the original paymentId as reference
Parameters:
Name Type Description
response remotepay.RefundPaymentResponse
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#onSaleResponse(response)

Will be called, one or more times, at the completion of a sale transaction request, with either a SUCCESS or CANCEL code. A SUCCESS will also have the payment object. The payment object can be the full amount 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 to determine if it is final or will be finalized during closeout.
Parameters:
Name Type Description
response remotepay.SaleResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onTipAdded(tipAdded)

Will be called when a tip is added on the device screen
Parameters:
Name Type Description
tipAdded remotepay.TipAdded
Source:
Returns:
void

(static) ICloverConnectorListener#onTipAdjustAuthResponse(response)

Will be called after a tip adjust request and contains the tipAmount if successful
Parameters:
Name Type Description
response remotepay.TipAdjustAuthResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onVaultCardResponse(response)

will be called at the completion of a vault card request, with either a SUCCESS or CANCEL code. If successful, the response will contain a payment with a token value unique for the card and merchant that can be used for future Sale or Auth requests.
Parameters:
Name Type Description
response remotepay.VaultCardResponse
Source:
Returns:
void

(static) ICloverConnectorListener#onVerifySignatureRequest(request)

Will be called, passing in the Payment and Signature, if the user provides an on-screen signature, that needs to be accepted or rejected for a payment.
Parameters:
Name Type Description
request remotepay.VerifySignatureRequest
Source:
Returns:
void

(static) ICloverConnectorListener#onVoidPaymentResponse(response)

Will be called after a void payment request and contains the voided paymentId
Parameters:
Name Type Description
response remotepay.VoidPaymentResponse
Source:
Returns:
void