- Source:
 
Classes
- ActivityMessage
 - AuthRequest
 - AuthResponse
 - BaseRequest
 - BaseResponse
 - BaseTransactionRequest
 - CapturePreAuthRequest
 - CapturePreAuthResponse
 - CardInfoRequest
 - CardInfoResponse
 - CheckBalanceRequest
 - CheckBalanceResponse
 - CloseoutRequest
 - CloseoutResponse
 - CloverDeviceErrorEvent
 - CloverDeviceEvent
 - ConfirmPaymentRequest
 - CustomActivityRequest
 - CustomActivityResponse
 - CustomerInfo
 - CustomerProvidedDataEvent
 - DataProviderConfig
 - DeviceEventEnum
 - DeviceInfo
 - DisplayReceiptOptionsRequest
 - DisplayReceiptOptionsResponse
 - ExternalDeviceStateData
 - ExternalDeviceStateEnum
 - ICloverConnector
 - ICloverConnectorListener
 - Img
 - IncrementPreAuthRequest
 - IncrementPreAuthResponse
 - InputOption
 - InvalidStateTransitionResponse
 - KeyPressEnum
 - ManualRefundRequest
 - ManualRefundResponse
 - MerchantInfo
 - MessageFromActivity
 - MessageToActivity
 - OpenCashDrawerRequest
 - PaymentResponse
 - PlatformError
 - PreAuthRequest
 - PreAuthResponse
 - PrintJobStatusRequest
 - PrintJobStatusResponse
 - PrintManualRefundDeclineReceiptMessage
 - PrintManualRefundReceiptMessage
 - PrintPaymentDeclineReceiptMessage
 - PrintPaymentMerchantCopyReceiptMessage
 - PrintPaymentReceiptMessage
 - PrintRefundPaymentReceiptMessage
 - PrintRefundPaymentReceiptResponse
 - PrintRequest
 - QueryStatusEnum
 - ReadCardDataRequest
 - ReadCardDataResponse
 - RefundPaymentRequest
 - RefundPaymentResponse
 - RegisterForCustomerProvidedDataRequest
 - ResetDeviceResponse
 - ResponseCodeEnum
 - ResultStatusEnum
 - RetrieveDeviceStatusRequest
 - RetrieveDeviceStatusResponse
 - RetrievePaymentRequest
 - RetrievePaymentResponse
 - RetrievePendingPaymentsResponse
 - RetrievePrintersRequest
 - RetrievePrintersResponse
 - SaleRequest
 - SaleResponse
 - SetCustomerInfoRequest
 - SignatureRequest
 - SignatureResponse
 - TipAdded
 - TipAdjustAuthRequest
 - TipAdjustAuthResponse
 - TipRequest
 - TipResponse
 - TransactionRequest
 - TransactionTypeEnum
 - VaultCardRequest
 - VaultCardResponse
 - VerifySignatureRequest
 - VoidCreditRequest
 - VoidCreditResponse
 - VoidPaymentRefundRequest
 - VoidPaymentRefundResponse
 - VoidPaymentRequest
 - VoidPaymentResponse
 
Members
(static) DeviceErrorEventCode :string
Type:
- string
 
Properties:
| Name | Type | Description | 
|---|---|---|
AbortEndpoint | 
            
            string | |
AccessDenied | 
            
            string | |
CancelIoFailed | 
            
            string | |
DeviceAllreadyLocked | 
            
            string | |
DeviceIoControl | 
            
            string | |
DeviceNotFound | 
            
            string | |
EndpointAllreadyLocked | 
            
            string | |
GetDeviceKeyValueFailed | 
            
            string | |
GetOverlappedResult | 
            
            string | |
GetString | 
            
            string | |
InsufficientMemory | 
            
            string | |
Interrupted | 
            
            string | |
InvalidConfig | 
            
            string | |
InvalidEndpoint | 
            
            string | |
InvalidParam | 
            
            string | |
IoCancelled | 
            
            string | |
IoControlMessage | 
            
            string | |
IoEndpointGlobalCancelRedo | 
            
            string | |
IoSyncFailed | 
            
            string | |
IoTimedOut | 
            
            string | |
MonoApiError | 
            
            string | |
None | 
            
            string | |
NotConnected | 
            
            string | |
NotSupported | 
            
            string | |
Ok | 
            
            string | |
Overflow | 
            
            string | |
PipeError | 
            
            string | |
ReadFailed | 
            
            string | |
ReceiveThreadTerminated | 
            
            string | |
ResourceBusy | 
            
            string | |
SendNotificationFailure | 
            
            string | |
SetDeviceKeyValueFailed | 
            
            string | |
Success | 
            
            string | |
UnknownError | 
            
            string | |
UserAborted | 
            
            string | |
Win32Error | 
            
            string | |
WriteFailed | 
            
            string | 
- Source:
 
(static) DeviceEventState :string
    We can not include WELCOME_SCREEN, THANKYOU_SCREEN, DISPLAY_MESSAGE, DISPLAY_ORDER until we can filter them out in remote-pay before they go through the interface to older versions of the sdk
    Type:
- string
 
Properties:
| Name | Type | Description | 
|---|---|---|
ADD_SIGNATURE | 
            
            string | |
ADD_SIGNATURE_CANCEL_CONFIRM | 
            
            string | |
ADD_TIP | 
            
            string | |
APPROVE_ELV_LIMIT_OVERRIDE | 
            
            string | |
APPROVED | 
            
            string | |
CANCELED | 
            
            string | |
CASHBACK_CONFIRM | 
            
            string | |
CASHBACK_SELECT | 
            
            string | |
CONFIGURING | 
            
            string | |
CONFIRM_AMOUNT | 
            
            string | |
CONFIRM_DUPLICATE_CHECK | 
            
            string | |
CONFIRM_PARTIAL_AUTH | 
            
            string | |
CONTACTLESS_TAP_REQUIRED | 
            
            string | |
CUSTOM_ACTIVITY | 
            
            string | |
CUSTOM_TIP_AMOUNT | 
            
            string | |
DCC_HOST_REQUEST | 
            
            string | |
DECLINED | 
            
            string | |
ENTER_INSTALLMENT_CODE | 
            
            string | |
ENTER_INSTALLMENTS | 
            
            string | |
ENTER_PAN_LAST_FOUR | 
            
            string | |
ERROR_SCREEN | 
            
            string | |
FAILED | 
            
            string | |
FATAL | 
            
            string | |
FISCAL_INVOICE_NUMBER | 
            
            string | |
FORCE_ACCEPTANCE | 
            
            string | |
HANDLE_TENDER | 
            
            string | |
INPUT_ERROR | 
            
            string | |
MANUAL_CARD_CVV | 
            
            string | |
MANUAL_CARD_CVV_UNREADABLE | 
            
            string | |
MANUAL_CARD_EXPIRATION | 
            
            string | |
MANUAL_CARD_NUMBER | 
            
            string | |
MANUAL_ENTRY_FALLBACK | 
            
            string | |
OFFLINE_PAYMENT_CONFIRM | 
            
            string | |
PACKET_EXCEPTION | 
            
            string | |
PERSONAL_ID_ENTRY | 
            
            string | |
PERSONAL_ID_ENTRY_PAS | 
            
            string | |
PIN_BYPASS_CONFIRM | 
            
            string | |
PIN_PAD | 
            
            string | |
PROCESSING | 
            
            string | |
PROCESSING_CREDIT | 
            
            string | |
PROCESSING_GO_ONLINE | 
            
            string | |
PROCESSING_SWIPE | 
            
            string | |
RECEIPT_OPTIONS | 
            
            string | |
REMOVE_CARD | 
            
            string | |
RETURN_TO_MERCHANT | 
            
            string | |
SELECT_ACCOUNT | 
            
            string | |
SELECT_APPLICATION | 
            
            string | |
SELECT_DCC | 
            
            string | |
SELECT_INSTALLMENT_PLAN | 
            
            string | |
SELECT_LANGUAGE | 
            
            string | |
SELECT_MULTI_MID | 
            
            string | |
SELECT_TIP | 
            
            string | |
SELECT_WITHDRAW_FROM_ACCOUNT | 
            
            string | |
SENSORY_EXPERIENCE | 
            
            string | |
SHOW_SEPA_MANDAT | 
            
            string | |
SIGNATURE_CUSTOMER_MODE | 
            
            string | |
SIGNATURE_ON_SCREEN_FALLBACK | 
            
            string | |
SIGNATURE_REJECT | 
            
            string | |
START | 
            
            string | |
STARTING_CUSTOM_ACTIVITY | 
            
            string | |
SWIPE_CVV_ENTRY | 
            
            string | |
TIMED_OUT | 
            
            string | |
TRY_AGAIN | 
            
            string | |
VERIFY_SIGNATURE_ON_PAPER | 
            
            string | |
VERIFY_SIGNATURE_ON_PAPER_CONFIRM_VOID | 
            
            string | |
VERIFY_SIGNATURE_ON_SCREEN | 
            
            string | |
VERIFY_SIGNATURE_ON_SCREEN_CONFIRM_VOID | 
            
            string | |
VERIFY_SURCHARGES | 
            
            string | |
VOICE_REFERRAL_RESULT | 
            
            string | |
VOID_CONFIRM | 
            
            string | |
VOIDED | 
            
            string | 
- Source:
 
(static) ErrorType :string
Type:
- string
 
Properties:
| Name | Type | Description | 
|---|---|---|
COMMUNICATION | 
            
            string | |
VALIDATION | 
            
            string | |
EXCEPTION | 
            
            string | 
- Source:
 
(static) ExternalDeviceState :string
Type:
- string
 
Properties:
| Name | Type | Description | 
|---|---|---|
IDLE | 
            
            string | |
BUSY | 
            
            string | |
WAITING_FOR_POS | 
            
            string | |
WAITING_FOR_CUSTOMER | 
            
            string | |
UNKNOWN | 
            
            string | 
- Source:
 
(static) KeyPress :string
Type:
- string
 
Properties:
| Name | Type | Description | 
|---|---|---|
NONE | 
            
            string | |
ENTER | 
            
            string | |
ESC | 
            
            string | |
BACKSPACE | 
            
            string | |
TAB | 
            
            string | |
STAR | 
            
            string | |
BUTTON_1 | 
            
            string | |
BUTTON_2 | 
            
            string | |
BUTTON_3 | 
            
            string | |
BUTTON_4 | 
            
            string | |
BUTTON_5 | 
            
            string | |
BUTTON_6 | 
            
            string | |
BUTTON_7 | 
            
            string | |
BUTTON_8 | 
            
            string | |
DIGIT_1 | 
            
            string | |
DIGIT_2 | 
            
            string | |
DIGIT_3 | 
            
            string | |
DIGIT_4 | 
            
            string | |
DIGIT_5 | 
            
            string | |
DIGIT_6 | 
            
            string | |
DIGIT_7 | 
            
            string | |
DIGIT_8 | 
            
            string | |
DIGIT_9 | 
            
            string | |
DIGIT_0 | 
            
            string | 
- Source:
 
(static) QueryStatus :string
Type:
- string
 
Properties:
| Name | Type | Description | 
|---|---|---|
FOUND | 
            
            string | |
NOT_FOUND | 
            
            string | |
IN_PROGRESS | 
            
            string | 
- Source:
 
(static) ResponseCode :string
Type:
- string
 
Properties:
| Name | Type | Description | 
|---|---|---|
SUCCESS | 
            
            string | |
FAIL | 
            
            string | |
UNSUPPORTED | 
            
            string | |
CANCEL | 
            
            string | |
DUPLICATE | 
            
            string | |
ERROR | 
            
            string | 
- Source:
 
(static) ResultStatus :string
Type:
- string
 
Properties:
| Name | Type | Description | 
|---|---|---|
SUCCESS | 
            
            string | |
FAIL | 
            
            string | |
CANCEL | 
            
            string | 
- Source:
 
(static) TransactionType :string
Type:
- string
 
Properties:
| Name | Type | Description | 
|---|---|---|
PAYMENT | 
            
            string | |
CREDIT | 
            
            string | |
AUTH | 
            
            string | |
DATA | 
            
            string | |
BALANCE_INQUIRY | 
            
            string | |
PAYMENT_REVERSAL | 
            
            string | |
PAYMENT_ADJUSTMENT | 
            
            string | |
CREDIT_REVERSAL | 
            
            string | |
REFUND_ADJUSTMENT | 
            
            string | |
CASH_ADVANCE | 
            
            string | |
CAPTURE_PREAUTH | 
            
            string | |
VAS_DATA | 
            
            string | |
VERIFY_CARD | 
            
            string | |
TOKENIZE_CARD | 
            
            string | 
- Source: