CloverConnector  4.0.3
Copyright (C) 2018 Clover Network, Inc.
com.clover.remotepay.sdk.DefaultCloverConnectorListener Class Referenceabstract

This is a default implementation of the ICloverConnectorListener that can be used for quickly creating applications by simply overriding the appropriate listener method(s) needed for testing a particular remote call. More...

Inheritance diagram for com.clover.remotepay.sdk.DefaultCloverConnectorListener:
com.clover.remotepay.sdk.ICloverConnectorListener

Public Member Functions

abstract void OnConfirmPaymentRequest (ConfirmPaymentRequest 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 an OnConfirmPaymentRequest() asking the merchant to reply by sending either an AcceptPayment() or RejectPayment() call. More...
 
virtual void OnVaultCardResponse (VaultCardResponse response)
 Called in response to a VaultCard() request. Contains a { More...
 
virtual void OnReadCardDataResponse (ReadCardDataResponse response)
 Called in response to a ReadCardData() request. Contains card information (specifically Track 1 and Track 2 card data). More...
 
virtual void OnCapturePreAuthResponse (CapturePreAuthResponse response)
 Called in response to a CapturePreAuth() request. Contains the new Amount and TipAmount if successful. More...
 
virtual void OnAuthResponse (AuthResponse 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. More...
 
virtual void OnPreAuthResponse (PreAuthResponse 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. More...
 
virtual void OnTipAdjustAuthResponse (TipAdjustAuthResponse response)
 Called in response to a tip adjustment for an Auth transaction. Contains the TipAmount if successful. More...
 
virtual void OnCloseoutResponse (CloseoutResponse response)
 Called in response to a Closeout() request. More...
 
virtual void OnDeviceActivityEnd (CloverDeviceEvent 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. More...
 
virtual void OnDeviceActivityStart (CloverDeviceEvent 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. More...
 
virtual void OnDeviceConnected ()
 Called when the Clover device is initially connected, but not ready to communicate. More...
 
virtual void OnDeviceDisconnected ()
 Called when the Clover device is disconnected from the CloverConnector or not responding. More...
 
virtual void OnDeviceError (CloverDeviceErrorEvent deviceErrorEvent)
 Called when an error occurs while trying to send messages to the Clover device. More...
 
virtual void OnDeviceReady (MerchantInfo merchantInfo)
 Called when the Clover device is ready to communicate and respond to requests. More...
 
virtual void OnManualRefundResponse (ManualRefundResponse response)
 Called in response to a ManualRefund() request. Contains a { More...
 
virtual void OnRefundPaymentResponse (RefundPaymentResponse response)
 Called in response to a RefundPayment() request. Contains a { More...
 
virtual void OnSaleResponse (SaleResponse response)
 Called at the completion of a Sale() request. The SaleResponse contains a { More...
 
virtual void OnVerifySignatureRequest (VerifySignatureRequest request)
 Called when the Clover device requests verification for a user's on-screen signature. The Payment and Signature will be passed in. More...
 
virtual void OnVoidPaymentResponse (VoidPaymentResponse response)
 Called in response to a VoidPayment() request. Contains a { More...
 
virtual void OnVoidPaymentRefundResponse (VoidPaymentRefundResponse response)
 Called in response to a VoidPaymentRefund() request with results. More...
 
virtual void OnTipAdded (TipAddedMessage message)
 Called when a customer selects a tip amount on the Clover device's screen. More...
 
virtual void OnRetrievePendingPaymentsResponse (RetrievePendingPaymentsResponse response)
 Called in response to a RetrievePendingPayment() request. More...
 
virtual void OnCustomActivityResponse (CustomActivityResponse response)
 Called when a Custom Activity finishes normally. More...
 
virtual void OnPrintManualRefundReceipt (PrintManualRefundReceiptMessage message)
 Called when a user requests a paper receipt for a Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request. More...
 
virtual void OnPrintManualRefundDeclineReceipt (PrintManualRefundDeclineReceiptMessage message)
 Called when a user requests a paper receipt for a declined Manual Refund. Will only be called if DisablePrinting = true on the ManualRefund() request. More...
 
virtual void OnPrintPaymentReceipt (PrintPaymentReceiptMessage message)
 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. More...
 
virtual void OnPrintPaymentDeclineReceipt (PrintPaymentDeclineReceiptMessage message)
 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. More...
 
virtual void OnPrintPaymentMerchantCopyReceipt (PrintPaymentMerchantCopyReceiptMessage message)
 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. More...
 
virtual void OnPrintRefundPaymentReceipt (PrintRefundPaymentReceiptMessage message)
 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. More...
 
virtual void OnRetrieveDeviceStatusResponse (RetrieveDeviceStatusResponse response)
 Called in response to a RetrieveDeviceStatus() request. More...
 
virtual void OnMessageFromActivity (MessageFromActivity response)
 Called when a Custom Activity sends a message to the POS. More...
 
virtual void OnResetDeviceResponse (ResetDeviceResponse response)
 Called in response to a ResetDevice() request. More...
 
virtual void OnRetrievePaymentResponse (RetrievePaymentResponse response)
 Called in response to a RetrievePayment() request. More...
 
virtual void OnPrintJobStatusResponse (PrintJobStatusResponse response)
 Called in response to a RetrievePrintJobStatus() request. More...
 
virtual void OnPrintJobStatusRequest (PrintJobStatusRequest request)
 Called in response to a RetrievePrintJobStatus() request. More...
 
virtual void OnRetrievePrintersResponse (RetrievePrintersResponse response)
 Called in response to a RetrievePrinters() request. More...
 
virtual void OnDisplayReceiptOptionsResponse (DisplayReceiptOptionsResponse response)
 Called in response to a DisplayReceiptOptions request. More...
 
virtual void OnCustomerProvidedData (CustomerProvidedDataEvent response)
 Called when Loyalty API sends customer identifying data for a loyalty data type subscribed to in CloverConnector.RegisterForCustomerProvidedData() More...
 
virtual void OnInvalidStateTransitionResponse (InvalidStateTransitionNotification notification)
 Called to notify the Point of Sale that a call was invalid in the current context or an internal state change failed. More...
 

Protected Member Functions

 DefaultCloverConnectorListener (ICloverConnector cloverConnector)
 

Detailed Description

This is a default implementation of the ICloverConnectorListener that can be used for quickly creating applications by simply overriding the appropriate listener method(s) needed for testing a particular remote call.

Also see the CloverEventConnector for another option to receive events instead of overriding the class and receiving method calls

Definition at line 349 of file ICloverConnectorListener.cs.

Constructor & Destructor Documentation

◆ DefaultCloverConnectorListener()

com.clover.remotepay.sdk.DefaultCloverConnectorListener.DefaultCloverConnectorListener ( ICloverConnector  cloverConnector)
protected

Definition at line 355 of file ICloverConnectorListener.cs.

Member Function Documentation

◆ OnAuthResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnAuthResponse ( AuthResponse  response)
virtual

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
responseThe AuthResponse to the transaction request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 372 of file ICloverConnectorListener.cs.

◆ OnCapturePreAuthResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnCapturePreAuthResponse ( CapturePreAuthResponse  response)
virtual

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

Parameters
responseThe CapturePreAuthResponse to the transaction request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 368 of file ICloverConnectorListener.cs.

◆ OnCloseoutResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnCloseoutResponse ( CloseoutResponse  response)
virtual

Called in response to a Closeout() request.

Parameters
responseThe CloseoutResponse details for the transaction request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 384 of file ICloverConnectorListener.cs.

◆ OnConfirmPaymentRequest()

abstract void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnConfirmPaymentRequest ( ConfirmPaymentRequest  request)
pure virtual

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 an OnConfirmPaymentRequest() 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 with Challenges.

Parameters
requestThe ConfirmPaymentRequest for confirmation.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

◆ OnCustomActivityResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnCustomActivityResponse ( CustomActivityResponse  response)
virtual

Called when a Custom Activity finishes normally.

Parameters
responseThe CustomActivityResponse.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 444 of file ICloverConnectorListener.cs.

◆ OnCustomerProvidedData()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnCustomerProvidedData ( CustomerProvidedDataEvent  response)
virtual

Called when Loyalty API sends customer identifying data for a loyalty data type subscribed to in CloverConnector.RegisterForCustomerProvidedData()

Parameters
responseThe CustomerProvidedDataEvent containing type and data payload, like PHONE, 555-1212 in type-specific custom encoding

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 504 of file ICloverConnectorListener.cs.

◆ OnDeviceActivityEnd()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceActivityEnd ( CloverDeviceEvent  deviceEvent)
virtual

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
deviceEventThe CloverDeviceEvent event.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 388 of file ICloverConnectorListener.cs.

◆ OnDeviceActivityStart()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceActivityStart ( CloverDeviceEvent  deviceEvent)
virtual

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
deviceEventThe CloverDeviceEvent event.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 392 of file ICloverConnectorListener.cs.

◆ OnDeviceConnected()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceConnected ( )
virtual

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

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 396 of file ICloverConnectorListener.cs.

◆ OnDeviceDisconnected()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceDisconnected ( )
virtual

Called when the Clover device is disconnected from the CloverConnector or not responding.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 400 of file ICloverConnectorListener.cs.

◆ OnDeviceError()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceError ( CloverDeviceErrorEvent  deviceErrorEvent)
virtual

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

Parameters
deviceErrorEventThe CloverDeviceErrorEvent event.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 404 of file ICloverConnectorListener.cs.

◆ OnDeviceReady()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDeviceReady ( MerchantInfo  merchantInfo)
virtual

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

Parameters
merchantInfoThe MerchantInfo details to associate with the device.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 408 of file ICloverConnectorListener.cs.

◆ OnDisplayReceiptOptionsResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnDisplayReceiptOptionsResponse ( DisplayReceiptOptionsResponse  response)
virtual

Called in response to a DisplayReceiptOptions request.

Parameters
responseThe DisplayReceiptOptionsResponse details for the response.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 500 of file ICloverConnectorListener.cs.

◆ OnInvalidStateTransitionResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnInvalidStateTransitionResponse ( InvalidStateTransitionNotification  message)
virtual

Called to notify the Point of Sale that a call was invalid in the current context or an internal state change failed.

Parameters
message

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 508 of file ICloverConnectorListener.cs.

◆ OnManualRefundResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnManualRefundResponse ( ManualRefundResponse  response)
virtual

Called in response to a ManualRefund() request. Contains a {

See also
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
responseThe ManualRefundResponse details for the transaction request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 412 of file ICloverConnectorListener.cs.

◆ OnMessageFromActivity()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnMessageFromActivity ( MessageFromActivity  response)
virtual

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

Parameters
responseThe MessageFromActivity details.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 476 of file ICloverConnectorListener.cs.

◆ OnPreAuthResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPreAuthResponse ( PreAuthResponse  response)
virtual

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
responseThe PreAuthResponse details.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 376 of file ICloverConnectorListener.cs.

◆ OnPrintJobStatusRequest()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintJobStatusRequest ( PrintJobStatusRequest  request)
virtual

Called in response to a RetrievePrintJobStatus() request.

Parameters
requestThe PrintJobStatusResponse details for the request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 492 of file ICloverConnectorListener.cs.

◆ OnPrintJobStatusResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintJobStatusResponse ( PrintJobStatusResponse  response)
virtual

Called in response to a RetrievePrintJobStatus() request.

Parameters
responseThe PrintJobStatusResponse details for the request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 488 of file ICloverConnectorListener.cs.

◆ OnPrintManualRefundDeclineReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintManualRefundDeclineReceipt ( PrintManualRefundDeclineReceiptMessage  message)
virtual

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

Parameters
messageThe PrintManualRefundDeclineReceiptMessage.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 452 of file ICloverConnectorListener.cs.

◆ OnPrintManualRefundReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintManualRefundReceipt ( PrintManualRefundReceiptMessage  message)
virtual

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

Parameters
messageA callback that asks the POS to print a receipt for a ManualRefund. Contains a Credit object.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 448 of file ICloverConnectorListener.cs.

◆ OnPrintPaymentDeclineReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintPaymentDeclineReceipt ( PrintPaymentDeclineReceiptMessage  message)
virtual

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.

Parameters
messageThe PrintPaymentDeclineReceiptMessage details.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 460 of file ICloverConnectorListener.cs.

◆ OnPrintPaymentMerchantCopyReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintPaymentMerchantCopyReceipt ( PrintPaymentMerchantCopyReceiptMessage  message)
virtual

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.

Parameters
messageThe PrintPaymentMerchantCopyReceiptMessage details.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 464 of file ICloverConnectorListener.cs.

◆ OnPrintPaymentReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintPaymentReceipt ( PrintPaymentReceiptMessage  message)
virtual

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.

Parameters
messageThe PrintPaymentReceiptMessage details.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 456 of file ICloverConnectorListener.cs.

◆ OnPrintRefundPaymentReceipt()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnPrintRefundPaymentReceipt ( PrintRefundPaymentReceiptMessage  message)
virtual

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.

Parameters
messageThe PrintRefundPaymentReceiptMessage details.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 468 of file ICloverConnectorListener.cs.

◆ OnReadCardDataResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnReadCardDataResponse ( ReadCardDataResponse  response)
virtual

Called in response to a ReadCardData() request. Contains card information (specifically Track 1 and Track 2 card data).

Parameters
responseThe ReadCardDataResponse details for the request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 364 of file ICloverConnectorListener.cs.

◆ OnRefundPaymentResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRefundPaymentResponse ( RefundPaymentResponse  response)
virtual

Called in response to a RefundPayment() request. Contains a {

See also
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
responseThe RefundPaymentResponse details for the transaction request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 416 of file ICloverConnectorListener.cs.

◆ OnResetDeviceResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnResetDeviceResponse ( ResetDeviceResponse  response)
virtual

Called in response to a ResetDevice() request.

Parameters
responseThe ResetDeviceResponse details for the request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 480 of file ICloverConnectorListener.cs.

◆ OnRetrieveDeviceStatusResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRetrieveDeviceStatusResponse ( RetrieveDeviceStatusResponse  response)
virtual

Called in response to a RetrieveDeviceStatus() request.

Parameters
responseThe RetrieveDeviceStatusResponse details for the request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 472 of file ICloverConnectorListener.cs.

◆ OnRetrievePaymentResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRetrievePaymentResponse ( RetrievePaymentResponse  response)
virtual

Called in response to a RetrievePayment() request.

Parameters
responseThe RetrievePaymentResponse details for the request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 484 of file ICloverConnectorListener.cs.

◆ OnRetrievePendingPaymentsResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRetrievePendingPaymentsResponse ( RetrievePendingPaymentsResponse  response)
virtual

Called in response to a RetrievePendingPayment() request.

Parameters
responseThe RetrievePendingPaymentsResponse details for the request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 440 of file ICloverConnectorListener.cs.

◆ OnRetrievePrintersResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnRetrievePrintersResponse ( RetrievePrintersResponse  response)
virtual

Called in response to a RetrievePrinters() request.

Parameters
responseThe RetrievePrintersResponse details for the request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 496 of file ICloverConnectorListener.cs.

◆ OnSaleResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnSaleResponse ( SaleResponse  response)
virtual

Called at the completion of a Sale() request. The SaleResponse contains a {

See also
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
responseThe SaleResponse details for the transaction request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 420 of file ICloverConnectorListener.cs.

◆ OnTipAdded()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnTipAdded ( TipAddedMessage  message)
virtual

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

Parameters
messageThe TipAddedMessage.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 436 of file ICloverConnectorListener.cs.

◆ OnTipAdjustAuthResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnTipAdjustAuthResponse ( TipAdjustAuthResponse  response)
virtual

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

Parameters
responseThe TipAdjustAuthResponse to the transaction request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 380 of file ICloverConnectorListener.cs.

◆ OnVaultCardResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnVaultCardResponse ( VaultCardResponse  response)
virtual

Called in response to a VaultCard() request. Contains a {

See also
com.clover.remote.client.messages.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.
Parameters
responseThe VaultCardResponse details for the request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 360 of file ICloverConnectorListener.cs.

◆ OnVerifySignatureRequest()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnVerifySignatureRequest ( VerifySignatureRequest  request)
virtual

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

Parameters
requestThe VerifySignatureRequest.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 424 of file ICloverConnectorListener.cs.

◆ OnVoidPaymentRefundResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnVoidPaymentRefundResponse ( VoidPaymentRefundResponse  response)
virtual

Called in response to a VoidPaymentRefund() request with results.

Parameters
response

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 432 of file ICloverConnectorListener.cs.

◆ OnVoidPaymentResponse()

virtual void com.clover.remotepay.sdk.DefaultCloverConnectorListener.OnVoidPaymentResponse ( VoidPaymentResponse  response)
virtual

Called in response to a VoidPayment() request. Contains a {

See also
com.clover.remote.client.messages.ResultCode} and a Success boolean. If successful, the response will also contain the paymentId for the voided Payment.
Parameters
responseThe VoidPaymentResponse details for the transaction request.

Implements com.clover.remotepay.sdk.ICloverConnectorListener.

Definition at line 428 of file ICloverConnectorListener.cs.


The documentation for this class was generated from the following file: