Show / Hide Table of Contents
TIM SDK24-09-2
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

Namespace SIX.TimApi

Classes

ActivateResponse

Contains the result of calling Activate() or ActivateAsync(). Immutable class.

Amount

Amount represents an Amount container

AmountDcc

Foreign Amount. Is local amount multiplied by the exchange rate.

AmountDiscount

Foreign Amount. Is local amount multiplied by the exchange rate.

AmountFinal

Final Amount. after a {@link Terminal#amtAdjustment(Amount)} has been process by the terminal.

Application

Information about a supported application. Immutable class.

BalanceInquiryResponse

Contains the result of a balance inquiry after calling BalanceInquiry() or BalanceInquiryAsync(). Immutable class.

BalanceResponse

Contains the result of a call to Balance() or BalanceAsync(). Immutable class.

Basket

BasketItem

Brand

Contains information about a brand available on the terminal. Immutable class. It is available after Login() or LoginAsync() has been performed or brands have been manually retrieved by ApplicationInformation() or ApplicationInformationAsync().

CardData

Contains card information.

CardTrackData

Holds the card track data. Track is specified by the TrackNum property.

ClientIdentificationResponse

Contains the result of a client identification finished after calling ClientIdentification() or ClientIdentificationAsync(). Immutable class.

CommandRequest

Command request to send to card.

CommandResponse

Response of a CommandRequest send to the card.

Immutable class

ConfigData

Contains terminal information required for ECR applications to produce receipts on their own. This data is available after the Login operation has been performed. Immutable class.

ConversionHelper

Counter

Contains information about a counter for a brand. Immutable class.

CounterList

Contains all counters as Counter for a specific counter type. Instances of this class are returned by various calls:

Balance()

BalanceAsync()

CounterRequest(CounterType)

CounterRequestAsync(CounterType)

Deactivate()

DeactivateAsync()

Reconciliation()

ReconciliationAsync()

CurrencyFunctions

CurrencyItem

Contains information about a currency supported by a brand. Immutable class.

DeactivateResponse

Result of calling the Deactivate() or DeactivateAsync(). Immutable 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.

DisplayProductInfo

Holds a product picture and related information for display.

For use by value added services.

The image is stored as byte array containing the image data.

EcrInfo

Defines one ECR information token for use by the HardwareInformation() or HardwareInformationAsync().

EndianReader

ErrorMessages

Localized error messages. This is a static only class.

Features

Contains features supported by the terminal. Immutable class.

FeaturesHardware

Hardware features supported by the terminal. Immutable class.

FeaturesPayment

Payment features supported by the terminal. Immutable class.

FeaturesSixml

SIXml features supported by the terminal. Immutable class.

Hardware

Contains information about a piece of hardware in the terminal or devices attached to it. Immutable class.

HardwareInformationResponse

Contains the result of calling the HardwareInformation() or HardwareInformationAsync(). Immutable class.

ImmutableTerminalSettings

InitTransactionResponse

ItemQuantity

KernelVersion

A KernelVersion in the KernelVersionList.

LoginRequest

Contains explicit login information for use with Login()} or LoginAsync(). Without using LoginRequest the information is assembled from the default parameters stored in the terminal properties.

LoyaltyCoupon

LoyaltyDiscount

LoyaltyInformation

A LoyaltyInformation in the LoyaltyInformationList.

LoyaltyItem

MerchantOption

A MerchantOption in the MerchantOptionList.

MobileTopupData

Mobile topup issuer information result.

MobileTopupValue

Contains the name of a mobile topup issuer and an associated voucher value.

NativeError

Native error information. Immutable class.

NetworkInformation

Contains network information of the terminal. Result of calling SystemInformation() or SystemInformationAsync(). Immutable class.

PpInfo

Class PpInfo.

PrintData

Contains receipts or receipt items for printing by the ECR depending on the PrintOptions used during login. Immutable class.

PrintOption

Print options for a specific receipt type. Used for {@link Terminal#login} or {@link Terminal#loginAsync}. Immutable class.

PrintOptionList

List of Print Options as PrintOption

Receipt

Class Receipt.

ReceiptItem

Class ReceiptItem.

ReceiptItems

Class ReceiptItems.

ReceiptRequestResponse

Contains the result of a call to the ReceiptRequest(ReceiptRequestType) or ReceiptRequestAsync(ReceiptRequestType). Immutable class.

ReconciliationResponse

Contains the result of calling the Reconciliation()} or ReconciliationAsync(). Immutable class.

ScreenshotInformation

Setting

Contains a setting to change on the EFT terminal. Used for the ChangeSettings(List<Setting>) or ChangeSettingsAsync(List<Setting>).

ShowDialogRequest

ShowDialogResponse

Contains the result of a show dialog request finished after calling ShowDialog(ShowDialogRequest) or ShowDialogAsync(ShowDialogRequest). Immutable class.

ShowSignatureCaptureRequest

ShowSignatureCaptureResponse

SignatureInformation

Contains signature information captured by the EFT Terminal as a result to calling the Transaction(TransactionType, Amount) or TransactionAsync(TransactionType, Amount). Immutable class.

SIXmlConstants

Class SIXmlConstants holds constants to be used for some integer properties.

SIXmlConstants.ResourceId

Class ResourceId holds constants for the ResourceId

SubTransaction

A SubTransaction is a part of an overall transaction. Only useful in context of Swiss Post Combined transaction type. Designed to mimic the EP2 7.2. Product Record of type Record Subtrx. Specification: banking.

SystemInformationResponse

Contains the result of calling the SystemInformation() or SystemInformationAsync(). Immutable class.

Terminal

Terminal.ActivateCompletedEventArgs

Terminal.ActivateServiceMenuCompletedEventArgs

Terminal.AgeCheckCompletedEventArgs

Terminal.ApplicationInformationCompletedEventArgs

Terminal.BalanceCompletedEventArgs

Terminal.BalanceInquiryCompletedEventArgs

Terminal.ChangeSettingsCompletedEventArgs

Terminal.ClientIdentificationCompletedEventArgs

Terminal.CloseDialogModeCompletedEventArgs

Terminal.CloseMaintenanceWindowCompletedEventArgs

Terminal.CloseReaderCompletedEventArgs

Terminal.CommitCompletedEventArgs

Terminal.CounterRequestCompletedEventArgs

Terminal.DccRatesCompletedEventArgs

Terminal.DeactivateCompletedEventArgs

Terminal.DeviceMaintenanceCompletedEventArgs

Terminal.EjectCardCompletedEventArgs

Terminal.FinishCheckoutCompletedEventArgs

Terminal.HardwareInformationCompletedEventArgs

Terminal.InitTransactionCompletedEventArgs

Terminal.InitTransactionWithDialogCompletedEventArgs

Terminal.KeyPressedNotificationArgs

Terminal.LoginCompletedEventArgs

Terminal.LogoutCompletedEventArgs

Terminal.LoyaltyDataCompletedEventArgs

Terminal.MobileTopupCompletedEventArgs

Terminal.MobileTopupIssuerInfoCompletedEventArgs

Terminal.OpenDialogModeCompletedEventArgs

Terminal.OpenMaintenanceWindowCompletedEventArgs

Terminal.OpenReaderCompletedEventArgs

Terminal.PrintOnTerminalCompletedEventArgs

Terminal.ProvideLoyaltyBasketCompletedEventArgs

Terminal.ProvideVasResultCompletedEventArgs

Terminal.RebootCompletedEventArgs

Terminal.ReceiptRequestCompletedEventArgs

Terminal.ReconciliationCompletedEventArgs

Terminal.ReconfigCompletedEventArgs

Terminal.RequestAliasCompletedEventArgs

Terminal.RequestCompletedEventArgs

Terminal.RollbackCompletedEventArgs

Terminal.SendCardCommandCompletedEventArgs

Terminal.ShowDialogCompletedEventArgs

Terminal.ShowSignatureCaptureCompletedEventArgs

Terminal.SoftwareUpdateCompletedEventArgs

Terminal.StartCheckoutCompletedEventArgs

Terminal.SystemInformationCompletedEventArgs

Terminal.TransactionCompletedEventArgs

Terminal.TransactionInfoRequestCompletedEventArgs

TerminalSettings

the Settings for one terminal.

TerminalStatus

The TerminalStatus function returns information about the state of the terminal. This includes the state of the state machines, display content, the card reader status and, if available card data

ThirdPartyAppPayload

ThirdPartyAppData information. Immutable class.

TimEvent

Contains event information for asynchronous method calls. It is send to listeners Immutable class.

TimException

Class TimException.

Total

Contains information about the total for one currency. Immutable class.

TransactionData

Contains configuration for transaction used by {@link Terminal.Transaction} or {@link Terminal.TransactionAsync}.

TransactionInfoRequestResponse

Contains the result of a call to the TransactionInfoRequest() or TransactionInfoRequestAsync(). Immutable class.

TransactionInformation

Contains information about a finished transaction after calling the Transaction(TransactionType, Amount) or Terminal. Immutable class.

TransactionRequest

Contains configuration for transaction used by Transaction(TransactionType, Amount) or TransactionAsync(TransactionType, Amount).

TransactionResponse

Command request to send to card.

TrxDetail

Create transaction detail.

VasCheckoutInformation

VasInformationList

VAS Information List. Immutable class.

VasResult

VAS Result. Immutable class.

Structs

CurrencyFunctions.CurrencyCodeEntry

Interfaces

TerminalListener

Listener for asynchronous terminal events.

Enums

EndianReader.Endianness

FeaturesPayment.AgeCheckSupport

Age check support.

FeaturesSixml.Support

Feature support.

RequestTypes

TransactionResponse.Action

Delegates

Terminal.ActivateCompletedEventHandler

Terminal.ActivateServiceMenuCompletedEventHandler

Terminal.AgeCheckCompletedEventHandler

Terminal.ApplicationInformationCompletedEventHandler

Terminal.BalanceCompletedEventHandler

Terminal.BalanceInquiryCompletedEventHandler

Terminal.ChangeSettingsCompletedEventHandler

Terminal.ClientIdentificationCompletedEventHandler

Terminal.CloseDialogModeCompletedEventHandler

Terminal.CloseMaintenanceWindowCompletedEventHandler

Terminal.CloseReaderCompletedEventHandler

Terminal.CommitCompletedEventHandler

Terminal.ConnectCompletedHandler

Terminal.CounterRequestCompletedEventHandler

Terminal.DccRatesCompletedEventHandler

Terminal.DeactivateCompletedEventHandler

Terminal.DeferredAuthEventHandler

Terminal.DeviceMaintenanceCompletedEventHandler

Terminal.DisconnectedHandler

Terminal.EjectCardCompletedEventHandler

Terminal.ErrorNotificationHandler

Terminal.FinishCheckoutCompletedEventHandler

Terminal.HardwareInformationCompletedEventHandler

Terminal.InitTransactionCompletedEventHandler

Terminal.InitTransactionWithDialogCompletedEventHandler

Terminal.KeyPressedEventHandler

Terminal.LicenseChangedEventHandler

Terminal.LoginCompletedEventHandler

Terminal.LogoutCompletedEventHandler

Terminal.LoyaltyDataCompletedEventHandler

Terminal.MobileTopupCompletedEventHandler

Terminal.MobileTopupIssuerInfoCompletedEventHandler

Terminal.OpenDialogModeCompletedEventHandler

Terminal.OpenMaintenanceWindowCompletedEventHandler

Terminal.OpenReaderCompletedEventHandler

Terminal.PrintOnTerminalCompletedEventHandler

Terminal.ProvideLoyaltyBasketCompletedEventHandler

Terminal.ProvideVasResultCompletedEventHandler

Terminal.RebootCompletedEventHandler

Terminal.ReceiptRequestCompletedEventHandler

Terminal.ReconciliationCompletedEventHandler

Terminal.ReconfigCompletedEventHandler

Terminal.RequestAliasCompletedEventHandler

Terminal.RollbackCompletedEventHandler

Terminal.ScreenshotHandler

Terminal.SendCardCommandCompletedEventHandler

Terminal.ShowDialogCompletedEventHandler

Terminal.ShowSignatureCaptureCompletedEventHandler

Terminal.SoftwareUpdateCompletedEventHandler

Terminal.StartCheckoutCompletedEventHandler

Terminal.SystemInformationCompletedEventHandler

Terminal.TerminalStatusChangedHandler

Terminal.ThirdPartyAppDataHandler

Terminal.TransactionCompletedEventHandler

Terminal.TransactionInfoRequestCompletedEventHandler

Terminal.VasInfoHandler

In This Article
  • Classes
  • Structs
  • Interfaces
  • Enums
  • Delegates
Back to top Worldline AG