Terminal

Members

(inner, constant) UIEventType

Properties:
Name Type Description
Idle

Idle 0x01

TransactionReady

TransactionReady 0x07

FallbackMSRReady

FallbackMSRReady 0x08

TransactionCancelled

TransactionCancelled 0x09

TransactionTimeout

TransactionTimeout 0x0A

ContactlessCollision

ContactlessCollision 0x0C

ContactlessReadSuccessful

ContactlessReadSuccessful 0x0F

ContactlessNotRemoved

ContactlessNotRemoved 0x10

ContactlessRemoved

ContactlessRemoved 0x11

ContactlessOnlineRequested

ContactlessOnlineRequested 0x15

ContactlessPinRequired

ContactlessPinRequired 0x16

ContactlessSignatureRequired

ContactlessSignatureRequired 0x17

ContactlessTransactionApprovedOffline

ContactlessTransactionApprovedOffline 0x18

ContactlessTransactionDeclinedOffline

ContactlessTransactionDeclinedOffline 0x19

ContactlessTransactionApprovedOnline

ContactlessTransactionApprovedOnline 0x1A

ContactlessTransactionDeclinedOnline

ContactlessTransactionDeclinedOnline 0x1B

ContactlessErrorFallbackMagstripe

ContactlessErrorFallbackMagstripe 0x1C

ContactlessErrorFallbackContact

ContactlessErrorFallbackContact 0x1D

ContactlessErrorFallbackOther

ContactlessErrorFallbackOther 0x1E

ContactlessTransactionTryAgain

ContactlessTransactionTryAgain 0x1F

ContactCardReadInitiated

ContactCardReadInitiated 0x20

ContactOnlineRequest

ContactOnlineRequest 0x21

ContactOnlinePINRequired

ContactOnlinePINRequired 0x22

ContactSignatureRequired

ContactSignatureRequired 0x23

ContactContinueTransaction

ContactContinueTransaction 0x24

ContactTransactionApprovedOffline

ContactTransactionApprovedOffline 0x25

ContactTransactionDeclinedOffline

ContactTransactionDeclinedOffline 0x26

ContactTransactionApprovedOnline

ContactTransactionApprovedOnline 0x27

ContactTransactionDeclinedOnline

ContactTransactionDeclinedOnline 0x28

ContactError

ContactError 0x29

ContactErrorCardCommunication

ContactErrorCardCommunication 0x2A

ContactErrorFallback

ContactErrorFallback 0x2B

ContactCardNotRemoved

ContactCardNotRemoved 0x2C

ContactCardRemoved

ContactCardRemoved 0x2D

ContactPINTryLimitExceeded

ContactPINTryLimitExceeded 0x2E

ContactLastPINTry

ContactLastPINTry 0x2F

ContactTryAgain

ContactTryAgain 0x30

ContactReferral

ContactReferral 0x31

MSRReadSuccessful

MSRReadSuccessful 0x32

MSRError

MSRError 0x33

ErrorCardCommunication

ErrorCardCommunication 0x34

Error

Error 0x35

ContactlessTransactionApprovedOnline

ContactlessTransactionApprovedOnline undefined

ContactlessTransactionDeclinedOnline

ContactlessTransactionDeclinedOnline undefined

PromptCreditDebit

PromptCreditDebit undefined

Type Definitions

DeviceInfo :Object

Properties:
Name Type Description
status Status

Information about the status of this device.

driverVersion String

The version of the driver

device USBDeviceInfo

The device info from the USB API

manufacturer String

The manufacturer name

model String

The model name

currentFirmware String

The current firmware version

requiresSupportedFirmware Boolean

If this driver requires the peripheral to have a specific firmware version

supportedFirmwares Array.<String>

Array of supported firmware versions

supportedDescriptors Array.<module:StandardDriverInterface~Descriptor>

List of support device vendorId, productId pairs.

KSNCRCS Array.<String>

A list of CRC16 values for the Key Serial Numbers found on the terminal.

UIEvent

UI Event object

Properties:
Name Type Description
event String

A hex string representing the event code

elementId String

A hex string representing the id of the element

uiEventType UIEventType

A number representing the ui event type *Note this is not present for every event type.

uiEventName UIEventType

A string representing the ui event type

data Buffer

The raw data provided with this event

eventData Object

Some events will provide some additonal data.

UIEventCallback(event)

Callback for handling the terminal UI Event

Parameters:
Name Type Description
event UIEvent

The UI Event object