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 TimException

Class TimException.

Inheritance
System.Object
TimException
Namespace: SIX.TimApi
Assembly: TimApi.dll
Syntax
public class TimException : System.Exception

Constructors

TimException(ResultCode)

Declaration
public TimException(ResultCode resultCode)
Parameters
Type Name Description
ResultCode resultCode

TimException(ResultCode, String, NativeError, PpInfo, Dictionary<String, String>, PrintData, Basket)

Declaration
public TimException(ResultCode resultCode, string errorMessage, NativeError nativeError, PpInfo ppInfo, Dictionary<string, string> additionalErrorInfo, PrintData printData, Basket rejectedBasket)
Parameters
Type Name Description
ResultCode resultCode
System.String errorMessage
NativeError nativeError
PpInfo ppInfo
Dictionary<System.String, System.String> additionalErrorInfo
PrintData printData
Basket rejectedBasket

TimException(ResultCode, String, String, NativeError, PpInfo, Dictionary<String, String>, PrintData, Basket)

Declaration
public TimException(ResultCode resultCode, string errorMessage, string localizedMessage, NativeError nativeError, PpInfo ppInfo, Dictionary<string, string> additionalErrorInfo, PrintData printData, Basket rejectedBasket)
Parameters
Type Name Description
ResultCode resultCode
System.String errorMessage
System.String localizedMessage
NativeError nativeError
PpInfo ppInfo
Dictionary<System.String, System.String> additionalErrorInfo
PrintData printData
Basket rejectedBasket

Fields

PrintData

Gets the print data.

Declaration
public PrintData PrintData
Field Value
Type Description
PrintData

The print data.

Properties

AdditionalErrorInfo

Gets the additional error information.

Declaration
public Dictionary<string, string> AdditionalErrorInfo { get; }
Property Value
Type Description
Dictionary<System.String, System.String>

The additional error information.

ErrorMessage

Returns the error message as transmitted from the terminal.

The message language depends on the terminal but will generally be in English.

An empty string is returned if the terminal does not send a message.

Declaration
public string ErrorMessage { get; }
Property Value
Type Description
System.String

LocalizedMessage

Returns the localised error message in human readable form derived from the error code sent by the terminal.

The message will be in the merchant language of the terminal provided systemInformation() has been executed (English otherwise).

Declaration
public string LocalizedMessage { get; }
Property Value
Type Description
System.String

NativeError

Gets the native error.

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

The native error.

PpInfo

Payment protocol specific information

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

RejectedBasket

Rejected basket as modified by host or null if absent. Used for {@link Guides#PETROL} only.

Declaration
public Basket RejectedBasket { get; }
Property Value
Type Description
Basket

ResultCode

Gets the result code.

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

Methods

LocalizeMessage(String)

Returns the localised error message in human readable form derived from the error code sent by the terminal.

The message will be in the language supplied in the parameter.

Valid language strings are currently: "en","de","de-AT","de-CH","fr", "fr-BE","fr-CH","it","bg","hr","cs","nl","nl-BE","nl-NL","el","hu", "lt","pl","pt","ro","sk","sl","es","sv","fi","no","da"

"de" defaults to "de-CH" "fr" defaults to "fr-CH" "nl" defaults to "nl-BE"

Declaration
public string LocalizeMessage(string language)
Parameters
Type Name Description
System.String language
Returns
Type Description
System.String

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
In This Article
  • Constructors
    • TimException(ResultCode)
    • TimException(ResultCode, String, NativeError, PpInfo, Dictionary<String, String>, PrintData, Basket)
    • TimException(ResultCode, String, String, NativeError, PpInfo, Dictionary<String, String>, PrintData, Basket)
  • Fields
    • PrintData
  • Properties
    • AdditionalErrorInfo
    • ErrorMessage
    • LocalizedMessage
    • NativeError
    • PpInfo
    • RejectedBasket
    • ResultCode
  • Methods
    • LocalizeMessage(String)
    • ToString()
Back to top Worldline AG