Show / Hide Table of Contents
TIM SDK
TIM API C#
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
    • ReconfigParameters
    • 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
    • ReconfigMode
    • 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 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

Inheritance
System.Object
TerminalStatus
Namespace: SIX.TimApi
Assembly: TimApi.dll
Syntax
public class TerminalStatus : object

Constructors

TerminalStatus(List<String>, ConnectionStatus, ManagementStatus, CardReaderStatus, TransactionStatus, SleepModeStatus, Boolean, CardData, Boolean, AmountFinal, Boolean)

Create terminal status.

Declaration
public TerminalStatus(List<String> displayContent, ConnectionStatus connectionStatus, ManagementStatus managementStatus, CardReaderStatus cardReaderStatus, TransactionStatus transactionStatus, SleepModeStatus sleepModeStatus, bool receiptInformation, CardData cardData, bool swUpdateAvailable, AmountFinal finalAmount, bool OwnRisk2ActivationStatus)
Parameters
Type Name Description
List<String> displayContent
ConnectionStatus connectionStatus
ManagementStatus managementStatus
CardReaderStatus cardReaderStatus
TransactionStatus transactionStatus
SleepModeStatus sleepModeStatus
System.Boolean receiptInformation
CardData cardData
System.Boolean swUpdateAvailable
AmountFinal finalAmount
System.Boolean OwnRisk2ActivationStatus

Properties

CardData

the card data if a card is present. null if no card

Declaration
public CardData CardData { get; }
Property Value
Type Description
CardData

CardReaderStatus

Actual card reader status.

Declaration
public CardReaderStatus CardReaderStatus { get; }
Property Value
Type Description
CardReaderStatus

ConnectionStatus

Current connection state.

Declaration
public ConnectionStatus ConnectionStatus { get; set; }
Property Value
Type Description
ConnectionStatus

Disconnected - LoggedOut - LoggedIn

DisplayContent

Gets the display content.

Declaration
public List<string> DisplayContent { get; }
Property Value
Type Description
List<System.String>

FinalAmount

If the amount of the original transaction has been adjusted.

Declaration
public AmountFinal FinalAmount { get; }
Property Value
Type Description
AmountFinal

ManagementStatus

Current management state.

Declaration
public ManagementStatus ManagementStatus { get; }
Property Value
Type Description
ManagementStatus

OwnRisk2ActivationStatus

Specifies if the OwnRisk2 functionality is activated at terminal side.

This field is returned in a standard TerminalStatus notification from terminal to ECR if the OwnRisk2 mode is activated. The absence of the OwnRisk2Activation in the TerminalStatus notification means that the OwnRisk2 mode is de-activated or not supported by the payment application.

Optional: Mandatory If OwnRisk2 mode is activated.

Guides: retail, unattended, valueAddedServices.

Declaration
public bool OwnRisk2ActivationStatus { get; }
Property Value
Type Description
System.Boolean

ReceiptInformation

indicates if a receibt is available.

Declaration
public bool ReceiptInformation { get; }
Property Value
Type Description
System.Boolean

true if [receipt information]; otherwise, false.

SleepModeStatus

Processing information of the actual sleep mode change.

Declaration
public SleepModeStatus SleepModeStatus { get; }
Property Value
Type Description
SleepModeStatus

SwUpdateAvailable

Gets if a software update is available.

Declaration
public bool SwUpdateAvailable { get; }
Property Value
Type Description
System.Boolean

TransactionStatus

Processing information of the actual transaction state.

Declaration
public TransactionStatus TransactionStatus { get; }
Property Value
Type Description
TransactionStatus

Methods

Copy()

Copies this instance.

Declaration
public TerminalStatus Copy()
Returns
Type Description
TerminalStatus

a copy this instance.

ToString()

String representation.

Declaration
public override String ToString()
Returns
Type Description
String
Back to top Worldline AG