Show / Hide Table of Contents
TIM SDK24-09
TIM API .NETv3.24.0
Implementation Guide
  • SIX.TimApi
    • ActivateResponse
    • Amount
    • AmountDcc
    • AmountDiscount
    • AmountFinal
    • Application
    • BalanceInquiryResponse
    • BalanceResponse
    • Basket
    • BasketItem
    • Brand
    • CardData
    • CardTrackData
    • ClientIdentificationResponse
    • CommandRequest
    • CommandResponse
    • ConfigData
    • ConversionHelper
    • Counter
    • CounterList
    • CurrencyFunctions
    • CurrencyFunctions.CurrencyCodeEntry
    • CurrencyItem
    • DeactivateResponse
    • DefaultTerminalListener
    • DisplayProductInfo
    • EcrInfo
    • EndianReader
    • EndianReader.Endianness
    • ErrorMessages
    • Features
    • FeaturesHardware
    • FeaturesPayment
    • FeaturesPayment.AgeCheckSupport
    • FeaturesSixml
    • FeaturesSixml.Support
    • Hardware
    • HardwareInformationResponse
    • ImmutableTerminalSettings
    • InitTransactionResponse
    • ItemQuantity
    • KernelVersion
    • LoginRequest
    • LoyaltyCoupon
    • LoyaltyDiscount
    • LoyaltyInformation
    • LoyaltyItem
    • MerchantOption
    • MobileTopupData
    • MobileTopupValue
    • NativeError
    • NetworkInformation
    • PpInfo
    • PrintData
    • PrintOption
    • PrintOptionList
    • Receipt
    • ReceiptItem
    • ReceiptItems
    • ReceiptRequestResponse
    • ReconciliationResponse
    • RequestTypes
    • ScreenshotInformation
    • Setting
    • ShowDialogRequest
    • ShowDialogResponse
    • ShowSignatureCaptureRequest
    • ShowSignatureCaptureResponse
    • SignatureInformation
    • SIXmlConstants
    • SIXmlConstants.ResourceId
    • SubTransaction
    • SystemInformationResponse
    • Terminal
    • Terminal.ActivateCompletedEventArgs
    • Terminal.ActivateCompletedEventHandler
    • Terminal.ActivateServiceMenuCompletedEventArgs
    • Terminal.ActivateServiceMenuCompletedEventHandler
    • Terminal.AgeCheckCompletedEventArgs
    • Terminal.AgeCheckCompletedEventHandler
    • Terminal.ApplicationInformationCompletedEventArgs
    • Terminal.ApplicationInformationCompletedEventHandler
    • Terminal.BalanceCompletedEventArgs
    • Terminal.BalanceCompletedEventHandler
    • Terminal.BalanceInquiryCompletedEventArgs
    • Terminal.BalanceInquiryCompletedEventHandler
    • Terminal.ChangeSettingsCompletedEventArgs
    • Terminal.ChangeSettingsCompletedEventHandler
    • Terminal.ClientIdentificationCompletedEventArgs
    • Terminal.ClientIdentificationCompletedEventHandler
    • Terminal.CloseDialogModeCompletedEventArgs
    • Terminal.CloseDialogModeCompletedEventHandler
    • Terminal.CloseMaintenanceWindowCompletedEventArgs
    • Terminal.CloseMaintenanceWindowCompletedEventHandler
    • Terminal.CloseReaderCompletedEventArgs
    • Terminal.CloseReaderCompletedEventHandler
    • Terminal.CommitCompletedEventArgs
    • Terminal.CommitCompletedEventHandler
    • Terminal.ConnectCompletedHandler
    • Terminal.CounterRequestCompletedEventArgs
    • Terminal.CounterRequestCompletedEventHandler
    • Terminal.DccRatesCompletedEventArgs
    • Terminal.DccRatesCompletedEventHandler
    • Terminal.DeactivateCompletedEventArgs
    • Terminal.DeactivateCompletedEventHandler
    • Terminal.DeferredAuthEventHandler
    • Terminal.DeviceMaintenanceCompletedEventArgs
    • Terminal.DeviceMaintenanceCompletedEventHandler
    • Terminal.DisconnectedHandler
    • Terminal.EjectCardCompletedEventArgs
    • Terminal.EjectCardCompletedEventHandler
    • Terminal.ErrorNotificationHandler
    • Terminal.FinishCheckoutCompletedEventArgs
    • Terminal.FinishCheckoutCompletedEventHandler
    • Terminal.HardwareInformationCompletedEventArgs
    • Terminal.HardwareInformationCompletedEventHandler
    • Terminal.InitTransactionCompletedEventArgs
    • Terminal.InitTransactionCompletedEventHandler
    • Terminal.InitTransactionWithDialogCompletedEventArgs
    • Terminal.InitTransactionWithDialogCompletedEventHandler
    • Terminal.KeyPressedEventHandler
    • Terminal.KeyPressedNotificationArgs
    • Terminal.LicenseChangedEventHandler
    • Terminal.LoginCompletedEventArgs
    • Terminal.LoginCompletedEventHandler
    • Terminal.LogoutCompletedEventArgs
    • Terminal.LogoutCompletedEventHandler
    • Terminal.LoyaltyDataCompletedEventArgs
    • Terminal.LoyaltyDataCompletedEventHandler
    • Terminal.MobileTopupCompletedEventArgs
    • Terminal.MobileTopupCompletedEventHandler
    • Terminal.MobileTopupIssuerInfoCompletedEventArgs
    • Terminal.MobileTopupIssuerInfoCompletedEventHandler
    • Terminal.OpenDialogModeCompletedEventArgs
    • Terminal.OpenDialogModeCompletedEventHandler
    • Terminal.OpenMaintenanceWindowCompletedEventArgs
    • Terminal.OpenMaintenanceWindowCompletedEventHandler
    • Terminal.OpenReaderCompletedEventArgs
    • Terminal.OpenReaderCompletedEventHandler
    • Terminal.PrintOnTerminalCompletedEventArgs
    • Terminal.PrintOnTerminalCompletedEventHandler
    • Terminal.ProvideLoyaltyBasketCompletedEventArgs
    • Terminal.ProvideLoyaltyBasketCompletedEventHandler
    • Terminal.ProvideVasResultCompletedEventArgs
    • Terminal.ProvideVasResultCompletedEventHandler
    • Terminal.RebootCompletedEventArgs
    • Terminal.RebootCompletedEventHandler
    • Terminal.ReceiptRequestCompletedEventArgs
    • Terminal.ReceiptRequestCompletedEventHandler
    • Terminal.ReconciliationCompletedEventArgs
    • Terminal.ReconciliationCompletedEventHandler
    • Terminal.ReconfigCompletedEventArgs
    • Terminal.ReconfigCompletedEventHandler
    • Terminal.RequestAliasCompletedEventArgs
    • Terminal.RequestAliasCompletedEventHandler
    • Terminal.RequestCompletedEventArgs
    • Terminal.RollbackCompletedEventArgs
    • Terminal.RollbackCompletedEventHandler
    • Terminal.ScreenshotHandler
    • Terminal.SendCardCommandCompletedEventArgs
    • Terminal.SendCardCommandCompletedEventHandler
    • Terminal.ShowDialogCompletedEventArgs
    • Terminal.ShowDialogCompletedEventHandler
    • Terminal.ShowSignatureCaptureCompletedEventArgs
    • Terminal.ShowSignatureCaptureCompletedEventHandler
    • Terminal.SoftwareUpdateCompletedEventArgs
    • Terminal.SoftwareUpdateCompletedEventHandler
    • Terminal.StartCheckoutCompletedEventArgs
    • Terminal.StartCheckoutCompletedEventHandler
    • Terminal.SystemInformationCompletedEventArgs
    • Terminal.SystemInformationCompletedEventHandler
    • Terminal.TerminalStatusChangedHandler
    • Terminal.ThirdPartyAppDataHandler
    • Terminal.TransactionCompletedEventArgs
    • Terminal.TransactionCompletedEventHandler
    • Terminal.TransactionInfoRequestCompletedEventArgs
    • Terminal.TransactionInfoRequestCompletedEventHandler
    • Terminal.VasInfoHandler
    • TerminalListener
    • TerminalSettings
    • TerminalStatus
    • ThirdPartyAppPayload
    • TimEvent
    • TimException
    • Total
    • TransactionData
    • TransactionInfoRequestResponse
    • TransactionInformation
    • TransactionRequest
    • TransactionResponse
    • TransactionResponse.Action
    • TrxDetail
    • VasCheckoutInformation
    • VasInformationList
    • VasResult
  • SIX.TimApi.Constants
    • AccountType
    • AdditionalInfoItem
    • AdjustmentResult
    • AdminFunctions
    • AgeCheckResult
    • AllowedAccounts
    • BrandBarBrand
    • BrandMode
    • CardProductType
    • CardReader
    • CardReaderStatus
    • ConnectionMode
    • ConnectionStatus
    • CounterType
    • CouponRejectionReason
    • Currency
    • CurrencyType
    • CustomerDataType
    • Cvm
    • DialogFunctions
    • EcrInfoType
    • FinancialTransactions
    • FunctionHint
    • Guides
    • HardwareType
    • ImageFileFormat
    • KernelType
    • LoyaltyFunctionType
    • MaintenanceType
    • ManagementStatus
    • MerchantAction
    • MerchantOptionType
    • MobileTopupType
    • NgvMode
    • NonFinancialTransactions
    • Outcome
    • PaymentProtocol
    • PosEntryMode
    • PrintFlag
    • PrintFormat
    • ProcessingDisposition
    • ProtocolLevel
    • ProtocolType
    • Reason
    • ReceiptItemType
    • ReceiptRequestType
    • ReceiptType
    • Recipient
    • RemoteFunctions
    • ResourceId
    • ResourceParameterType
    • ResponseType
    • ResultCode
    • SecurityStatus
    • SettingType
    • SleepModeStatus
    • StatusFunctions
    • Theme
    • ThirdPartyAppId
    • ThirdPartyApps
    • TokenPanType
    • TransactionReason
    • TransactionStatus
    • TransactionType
    • UpdateStatus
    • VasInfoListType
    • VasInfoType
  • SIX.TimApi.Receipts
    • CompactReceiptFormatter
    • CustomReceiptFormatter
    • CustomReceiptFormatter.Condition
    • CustomReceiptFormatter.Counters
    • CustomReceiptFormatter.LineFormat
    • CustomReceiptFormatter.TextAlignment
    • CustomReceiptFormatter.TextElement
    • CustomReceiptFormatter.TextType
    • CustomReceiptFormatter.TranslatedText
    • DelegatableReceiptFormatter
    • NormalReceiptFormatter
    • RdfReceiptFormatter
    • ReceiptFormatter
    • SuperCompactReceiptFormatter
    • UltraCompactReceiptFormatter
  • SIX.TimApi.Utility.Logger
    • Level
    • Logger
    • Logger.ArchiveMode
    • Logger.CodeBlock
    • Logger.CodeBlock<T>
    • LogRecord

Class DefaultTerminalListener

Default implementation of listener for asynchronous terminal events. Implements methods to call RequestCompleted() and PrintReceipts() as convenience call.

Subclasses usually only overwrite RequestCompleted() and PrintReceipts(). If you overwrite methods inherited from TerminalListener make sure to super call to still get RequestCompleted() and PrintReceipts() called.

Inheritance
System.Object
DefaultTerminalListener
Implements
TerminalListener
Namespace: SIX.TimApi
Assembly: TimApi.dll
Syntax
public class DefaultTerminalListener : object, TerminalListener

Constructors

DefaultTerminalListener()

Create default terminal listener instance.

Declaration
public DefaultTerminalListener()

Methods

ActivateCompleted(TimEvent, ActivateResponse)

Called if an Terminal.activateAsync() started request finished.

Declaration
public virtual void ActivateCompleted(TimEvent tevent, ActivateResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

ActivateResponse data

Contains activation sequence counter and print information for the merchant.

ActivateServiceMenuCompleted(TimEvent)

Called if an Terminal.activateServiceMenuAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration
public virtual void ActivateServiceMenuCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

AgeCheckCompleted(TimEvent, TransactionInformation)

Called if an Terminal.AgeCheckAsync() started request finished.

Supported only if Guides.REMOTE is enabled.

Declaration
public virtual void AgeCheckCompleted(TimEvent tevent, TransactionInformation data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

TransactionInformation data

Contains transaction result information and print information for the merchant and cardholder.

ApplicationInformationCompleted(TimEvent)

Called if an Terminal.applicationInformationAsync() started request finished.

Declaration
public virtual void ApplicationInformationCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

BalanceCompleted(TimEvent, BalanceResponse)

Called if an Terminal.balanceAsync() started request finished.

Declaration
public virtual void BalanceCompleted(TimEvent tevent, BalanceResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

BalanceResponse data

Contains counters and print information for the merchant.

BalanceInquiryCompleted(TimEvent, BalanceInquiryResponse)

Called if an Terminal.balanceInquiryAsync() started request finished.

Supported only if Guides.ADVANCED_RETAIL is enabled.

Declaration
public virtual void BalanceInquiryCompleted(TimEvent tevent, BalanceInquiryResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

BalanceInquiryResponse data

ChangeSettingsCompleted(TimEvent)

Called if an Terminal.changeSettingsAsync(java.util.Map) started request finished.

Declaration
public virtual void ChangeSettingsCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

ClientIdentificationCompleted(TimEvent, ClientIdentificationResponse)

Called if an Terminal.clientIdentification() or Terminal.clientIdentificationAsync() started request finished.

Declaration
public virtual void ClientIdentificationCompleted(TimEvent tevent, ClientIdentificationResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

ClientIdentificationResponse data

Contains result information and print information for the merchant and cardholder.

CloseDialogModeCompleted(TimEvent)

Called if an Terminal.closeDialogModeAsync() started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration
public virtual void CloseDialogModeCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

CloseMaintenanceWindowCompleted(TimEvent)

Called if an Terminal.closeMaintenanceWindowAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration
public virtual void CloseMaintenanceWindowCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

CloseReaderCompleted(TimEvent)

Called if an Terminal.closeReaderAsync started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration
public virtual void CloseReaderCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

CommitCompleted(TimEvent, PrintData)

Called if an Terminal.commitAsync() started request finished.

Declaration
public virtual void CommitCompleted(TimEvent tevent, PrintData data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

PrintData data

ConnectCompleted(TimEvent)

Called if an Terminal.connect() started request finished.

Declaration
public virtual void ConnectCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

CounterRequestCompleted(TimEvent, CounterList)

Called if an Terminal.counterRequestAsync(com.six.timapi.constants.CounterType) started request finished.

Declaration
public virtual void CounterRequestCompleted(TimEvent tevent, CounterList data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

CounterList data

Contains counters.

DccRatesCompleted(TimEvent, PrintData)

Called if an Terminal.dccRatesAsync() started request finished.

Declaration
public virtual void DccRatesCompleted(TimEvent tevent, PrintData data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

PrintData data

Contains print information for merchant.

DeactivateCompleted(TimEvent, DeactivateResponse)

Called if an Terminal.deactivateAsync() started request finished.

Declaration
public virtual void DeactivateCompleted(TimEvent tevent, DeactivateResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

DeactivateResponse data

Contains counters and print information for the merchant.

DeferredAuth(Terminal, TransactionResponse)

Called if a Deferred Authorization Notification has been received.

Supported only if Guides.UNATTENDED is enabled.

Declaration
public virtual void DeferredAuth(Terminal terminal, TransactionResponse response)
Parameters
Type Name Description
Terminal terminal
TransactionResponse response

DeviceMaintenanceCompleted(TimEvent)

Called if an Terminal.deviceMaintenanceAsync() started request finished.

Supported only if Guides.REMOTE is enabled.

Declaration
public virtual void DeviceMaintenanceCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

Disconnected(Terminal, TimException)

Connection to terminal closed. Called if user disconnected or connection has been lost.

Declaration
public virtual void Disconnected(Terminal terminal, TimException exception)
Parameters
Type Name Description
Terminal terminal

Terminal sending the notification.

TimException exception

EjectCardCompleted(TimEvent)

Called if an Terminal.ejectCardAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration
public virtual void EjectCardCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

ErrorNotification(Terminal, TimException)

Called if a terminal send an Error Notification.

Declaration
public virtual void ErrorNotification(Terminal terminal, TimException error)
Parameters
Type Name Description
Terminal terminal
TimException error

FinishCheckoutCompleted(TimEvent, VasCheckoutInformation)

Called if an Terminal.finishCheckoutAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration
public virtual void FinishCheckoutCompleted(TimEvent tevent, VasCheckoutInformation data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

VasCheckoutInformation data

HardwareInformationCompleted(TimEvent, HardwareInformationResponse)

Called if an Terminal.hardwareInformationAsync started request finished.

Declaration
public virtual void HardwareInformationCompleted(TimEvent tevent, HardwareInformationResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

HardwareInformationResponse data

Contains information about EFT Terminal hardware and EMV kernels and configuration parameters supported by the EFT Terminal.

InitTransactionCompleted(TimEvent, CardData)

Called if an Terminal.initTransactionAsync(boolean, Amount) started request finished.

Declaration
public virtual void InitTransactionCompleted(TimEvent tevent, CardData data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

CardData data

InitTransactionWithDialogCompleted(TimEvent, InitTransactionResponse)

Called if an Terminal.initTransactionWithDialogAsync(Amount, ShowDialogRequest) started request finished.

Declaration
public virtual void InitTransactionWithDialogCompleted(TimEvent tevent, InitTransactionResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

InitTransactionResponse data

KeyPressed(Terminal, Reason)

Called if a Key Pressed Notification has been received.

Supported only if Guides.UNATTENDED is enabled.

Declaration
public virtual void KeyPressed(Terminal terminal, Reason reason)
Parameters
Type Name Description
Terminal terminal
Reason reason

LoginCompleted(TimEvent)

Called if an Terminal.loginAsync() started request finished.

Declaration
public virtual void LoginCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

LogoutCompleted(TimEvent)

Called if an Terminal.logoutAsync() started request finished.

Declaration
public virtual void LogoutCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

LoyaltyDataCompleted(TimEvent, CardData)

Called if an Terminal.loyaltyDataAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration
public virtual void LoyaltyDataCompleted(TimEvent tevent, CardData data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

CardData data

MobileTopupCompleted(TimEvent, MobileTopupData)

Called if an Terminal.mobileTopupAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration
public virtual void MobileTopupCompleted(TimEvent tevent, MobileTopupData data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

MobileTopupData data

MobileTopupIssuerInfoCompleted(TimEvent, List<MobileTopupValue>)

Called if an Terminal.mobileTopupIssuerInfoAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration
public virtual void MobileTopupIssuerInfoCompleted(TimEvent tevent, List<MobileTopupValue> data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

List<MobileTopupValue> data

OpenDialogModeCompleted(TimEvent)

Called if an Terminal.openDialogModeAsync() started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration
public virtual void OpenDialogModeCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

OpenMaintenanceWindowCompleted(TimEvent)

Called if an Terminal.openMaintenanceWindowAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration
public virtual void OpenMaintenanceWindowCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

OpenReaderCompleted(TimEvent)

Called if an Terminal.openReaderAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration
public virtual void OpenReaderCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

PrintOnTerminalCompleted(TimEvent)

Called if an Terminal.printOnTerminalAsync() started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration
public virtual void PrintOnTerminalCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

PrintReceipts(Terminal, PrintData)

Called by all request specific methods containing print data. Convenience method to print all receipts send by the terminal. Contains final receipts to print. If the print data sent to the request completed methods contains fields only Terminal.ReceiptFormatter is used to create final receipts for printing.

The following request completed methods contain receipts send to this method:

  • activateCompleted
  • balanceCompleted
  • deactivateCompleted
  • dccRatesCompleted
  • receiptRequestCompleted
  • reconciliationCompleted
  • reconfigCompleted
  • rollbackCompleted
  • transactionCompleted

PrintReceipts() is called before RequestCompleted().

Declaration
public virtual void PrintReceipts(Terminal terminal, PrintData printData)
Parameters
Type Name Description
Terminal terminal

Terminal receiving the receipts.

PrintData printData

Print data containing receipts to print.

ProvideLoyaltyBasketCompleted(TimEvent, List<LoyaltyItem>)

Called if an Terminal.provideLoyaltyBasketAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration
public virtual void ProvideLoyaltyBasketCompleted(TimEvent tevent, List<LoyaltyItem> data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

List<LoyaltyItem> data

ProvideVasResultCompleted(TimEvent, VasResult)

Called if an Terminal.provideVasResultAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration
public virtual void ProvideVasResultCompleted(TimEvent tevent, VasResult data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

VasResult data

RebootCompleted(TimEvent)

Called if an Terminal.rebootAsync() started request finished.

Declaration
public virtual void RebootCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

ReceiptRequestCompleted(TimEvent, ReceiptRequestResponse)

Called if an Terminal.receiptRequestAsync(com.six.timapi.constants.ReceiptRequestType) started request finished.

Declaration
public virtual void ReceiptRequestCompleted(TimEvent tevent, ReceiptRequestResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

ReceiptRequestResponse data

Contains all requested receipts up to a maximum number of receipts the EFT Terminal can send. if HasMoreReceipts is True not all receipts could be send by the EFT Terminal. call ReceiptRequest again to obtain more receipts.

ReconciliationCompleted(TimEvent, ReconciliationResponse)

Called if an Terminal.reconciliationAsync() started request finished.

Declaration
public virtual void ReconciliationCompleted(TimEvent tevent, ReconciliationResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

ReconciliationResponse data

Contains counters and print information for the merchant.

ReconfigCompleted(TimEvent, PrintData)

Called if an Terminal.reconfigAsync() started request finished.

Declaration
public virtual void ReconfigCompleted(TimEvent tevent, PrintData data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

PrintData data

Contains print information for the merchant.

RequestAliasCompleted(TimEvent, String)

Called if an Terminal.requestAlias() started request finished.

Declaration
public virtual void RequestAliasCompleted(TimEvent tevent, string data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

System.String data

RequestCompleted(TimEvent, Object)

Called by all of the other request specific methods unless they are implemented differently.

Declaration
public virtual void RequestCompleted(TimEvent tevent, Object data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the tevent and error information if the request failed.

Object data

Contains additional request specific data. Can be None-Value if the request in question does not support any additional data. Cast to the matching type to use. Use tevent.getRequestType() to determine the type of request.

RollbackCompleted(TimEvent, PrintData)

Called if an Terminal.rollbackAsync() started request finished.

Declaration
public virtual void RollbackCompleted(TimEvent tevent, PrintData data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

PrintData data

Contains print information for the merchant and cardholder.

Screenshot(Terminal, ScreenshotInformation)

Called if a Screenshot Notification has been received.

Supported only if Guides.REMOTE is enabled.

Declaration
public virtual void Screenshot(Terminal terminal, ScreenshotInformation info)
Parameters
Type Name Description
Terminal terminal
ScreenshotInformation info

SendCardCommandCompleted(TimEvent, List<CommandResponse>)

Called if an Terminal.sendCardCommand(List) started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration
public virtual void SendCardCommandCompleted(TimEvent tevent, List<CommandResponse> data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

List<CommandResponse> data

ShowDialogCompleted(TimEvent, ShowDialogResponse)

Called if an Terminal.showDialogAsync(ShowDialogRequest) started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration
public virtual void ShowDialogCompleted(TimEvent tevent, ShowDialogResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

ShowDialogResponse data

ShowSignatureCaptureCompleted(TimEvent, ShowSignatureCaptureResponse)

Called if an Terminal.showSignatureCaptureAsync(ShowSignatureCaptureRequest) started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration
public virtual void ShowSignatureCaptureCompleted(TimEvent tevent, ShowSignatureCaptureResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

ShowSignatureCaptureResponse data

SoftwareUpdateCompleted(TimEvent, UpdateStatus)

Called if an Terminal.softwareUpdateAsync() started request finished.

Declaration
public virtual void SoftwareUpdateCompleted(TimEvent tevent, UpdateStatus data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

UpdateStatus data

Contains update status.

StartCheckoutCompleted(TimEvent)

Called if an Terminal.startCheckoutAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration
public virtual void StartCheckoutCompleted(TimEvent tevent)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

SystemInformationCompleted(TimEvent, SystemInformationResponse)

Called if an Terminal.systemInformationAsync() started request finished.

Declaration
public virtual void SystemInformationCompleted(TimEvent tevent, SystemInformationResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

SystemInformationResponse data

Contains configuration and network information of the terminal.

TerminalStatusChanged(Terminal)

Called if the state of the terminal changed. Retrieve the state using event.getTerminal().getTerminalState().

Declaration
public virtual void TerminalStatusChanged(Terminal terminal)
Parameters
Type Name Description
Terminal terminal

Terminal sending the notification.

ThirdPartyAppData(Terminal, ThirdPartyAppPayload)

Called if a ThirdPartyAppData Notification has been received.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration
public virtual void ThirdPartyAppData(Terminal terminal, ThirdPartyAppPayload data)
Parameters
Type Name Description
Terminal terminal
ThirdPartyAppPayload data

TransactionCompleted(TimEvent, TransactionResponse)

Called if an Terminal.transactionAsync(com.six.timapi.constants.TransactionType, Amount) or Terminal.transactionAsync(com.six.timapi.constants.TransactionType, TransactionRequest) started request finished.

Declaration
public virtual void TransactionCompleted(TimEvent tevent, TransactionResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

TransactionResponse data

Contains transaction result information and print information for the merchant and cardholder.

TransactionInfoRequestCompleted(TimEvent, TransactionInfoRequestResponse)

Called if an Terminal.TransactionInfoRequestAsync() started request finished.

Declaration
public virtual void TransactionInfoRequestCompleted(TimEvent tevent, TransactionInfoRequestResponse data)
Parameters
Type Name Description
TimEvent tevent

Contains the terminal sending the event and error information if the request failed.

TransactionInfoRequestResponse data

Contains all requested receipts up to a maximum number of receipts the EFT Terminal can send. if HasMoreReceipts is True not all receipts could be send by the EFT Terminal. call TransactionInfoRequest again to obtain more receipts.

VasInfo(Terminal, VasCheckoutInformation)

Called if an VAS Information Notification has been received.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration
public virtual void VasInfo(Terminal terminal, VasCheckoutInformation vasInfo)
Parameters
Type Name Description
Terminal terminal
VasCheckoutInformation vasInfo

Implements

TerminalListener
In This Article
  • Constructors
    • DefaultTerminalListener()
  • Methods
    • ActivateCompleted(TimEvent, ActivateResponse)
    • ActivateServiceMenuCompleted(TimEvent)
    • AgeCheckCompleted(TimEvent, TransactionInformation)
    • ApplicationInformationCompleted(TimEvent)
    • BalanceCompleted(TimEvent, BalanceResponse)
    • BalanceInquiryCompleted(TimEvent, BalanceInquiryResponse)
    • ChangeSettingsCompleted(TimEvent)
    • ClientIdentificationCompleted(TimEvent, ClientIdentificationResponse)
    • CloseDialogModeCompleted(TimEvent)
    • CloseMaintenanceWindowCompleted(TimEvent)
    • CloseReaderCompleted(TimEvent)
    • CommitCompleted(TimEvent, PrintData)
    • ConnectCompleted(TimEvent)
    • CounterRequestCompleted(TimEvent, CounterList)
    • DccRatesCompleted(TimEvent, PrintData)
    • DeactivateCompleted(TimEvent, DeactivateResponse)
    • DeferredAuth(Terminal, TransactionResponse)
    • DeviceMaintenanceCompleted(TimEvent)
    • Disconnected(Terminal, TimException)
    • EjectCardCompleted(TimEvent)
    • ErrorNotification(Terminal, TimException)
    • FinishCheckoutCompleted(TimEvent, VasCheckoutInformation)
    • HardwareInformationCompleted(TimEvent, HardwareInformationResponse)
    • InitTransactionCompleted(TimEvent, CardData)
    • InitTransactionWithDialogCompleted(TimEvent, InitTransactionResponse)
    • KeyPressed(Terminal, Reason)
    • LoginCompleted(TimEvent)
    • LogoutCompleted(TimEvent)
    • LoyaltyDataCompleted(TimEvent, CardData)
    • MobileTopupCompleted(TimEvent, MobileTopupData)
    • MobileTopupIssuerInfoCompleted(TimEvent, List<MobileTopupValue>)
    • OpenDialogModeCompleted(TimEvent)
    • OpenMaintenanceWindowCompleted(TimEvent)
    • OpenReaderCompleted(TimEvent)
    • PrintOnTerminalCompleted(TimEvent)
    • PrintReceipts(Terminal, PrintData)
    • ProvideLoyaltyBasketCompleted(TimEvent, List<LoyaltyItem>)
    • ProvideVasResultCompleted(TimEvent, VasResult)
    • RebootCompleted(TimEvent)
    • ReceiptRequestCompleted(TimEvent, ReceiptRequestResponse)
    • ReconciliationCompleted(TimEvent, ReconciliationResponse)
    • ReconfigCompleted(TimEvent, PrintData)
    • RequestAliasCompleted(TimEvent, String)
    • RequestCompleted(TimEvent, Object)
    • RollbackCompleted(TimEvent, PrintData)
    • Screenshot(Terminal, ScreenshotInformation)
    • SendCardCommandCompleted(TimEvent, List<CommandResponse>)
    • ShowDialogCompleted(TimEvent, ShowDialogResponse)
    • ShowSignatureCaptureCompleted(TimEvent, ShowSignatureCaptureResponse)
    • SoftwareUpdateCompleted(TimEvent, UpdateStatus)
    • StartCheckoutCompleted(TimEvent)
    • SystemInformationCompleted(TimEvent, SystemInformationResponse)
    • TerminalStatusChanged(Terminal)
    • ThirdPartyAppData(Terminal, ThirdPartyAppPayload)
    • TransactionCompleted(TimEvent, TransactionResponse)
    • TransactionInfoRequestCompleted(TimEvent, TransactionInfoRequestResponse)
    • VasInfo(Terminal, VasCheckoutInformation)
  • Implements
Back to top Worldline AG