Show / Hide Table of Contents
TIM SDK22-09
TIM API .NETv3.19.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
    • 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
    • NormalReceiptFormatter
    • ReceiptFormatter
    • SuperCompactReceiptFormatter
    • UltraCompactReceiptFormatter
  • SIX.TimApi.Utility.Logger
    • Level
    • Logger
    • Logger.ArchiveMode
    • Logger.CodeBlock
    • Logger.CodeBlock<T>
    • LogRecord

Namespace SIX.TimApi.Constants

Classes

Currency

Currency codes.

Enums

AccountType

Identifies the selected account. If Account Selection is enabled, the transaction responses should contain this field. Default value is Credit.

AdditionalInfoItem

AdditionalInfoItem enumeration.

AdjustmentResult

Specifies if an amount adjustment notification was handled correctly. 0 for success.

This field is returned in a standard TerminalStatus notification from terminal to ECR in case an AmtAdjustment notification as been sent from ECR to terminal.

The following values are valid:

Specification: unattended.

AdminFunctions

Flag constants for FeatureType and OptionType sixml:AdminFunctions value.

AgeCheckResult

Outcome of age verification.

AllowedAccounts

Constants for AllowedAccounts tag or&ed together. Not set flags are restricted.

BrandBarBrand

Brands that can be used in the BrandBar tag.

Specification: dialog.

BrandMode

This attribute is used to specify which Brand icons are shown in the BrandBar element in a dialog.

The following values are valid:

Specification: dialog.

CardProductType

Gives the type of card product if this can be determined (e.g. from ASRPD).

The following values are valid:

CardReader

Defines that shall be used for the card commands.

The following values are valid:

Specification: dialog.

CardReaderStatus

The CardReaderStatus tag is used to transport information about the current card reader activity.

The following values are valid:

ConnectionMode

ConnectionStatus

The sixml:ConnectionStatus tag is used to transport information about the current connection between the ECR and the terminal.

All status information tags always contain the current status of the terminal, not the ECR.

The following values are valid:

CounterType

Identifies the type of transaction counter.

This type identifier is used to define what kind of counters shall be returned in the "CounterRequest" response.

The following values are valid:

CouponRejectionReason

Defines why a coupon has been rejected.

The following values are valid:

Specification: valueAddedServices.

CurrencyType

Specifies the type of currency. Used to distinguish between base and DCC currencies.

The following values are valid:

CustomerDataType

Specifies what kind of customer information the sixml:CustomerDataItem contains.

The following values are valid:

Cvm

Specifies which cardholder verification method has been performed during the transaction.

The supported cardholder verification methods are defined both, on the terminal and on the card. The first match of both sides will be performed according to EMV Book 3 [B11].

The following values are valid:

DialogFunctions

Flag constants for FeatureType and OptionType sixml:DialogFunctions value.

EcrInfoType

The EcrInfoType attribute is used to specify what kind of information is sent in the sixml:EcrInfo tag.

The following values are valid:

FinancialTransactions

Flag constants for FeatureType and OptionType sixml:FinancialTransactions value.

Guides: retail, petrol, unattended, advancedRetail, banking, hospitality, valueAddedServices.

FunctionHint

Hint to the subsequent Finacial Transaction Function that will be called in the “WaitForProceed”-state following an InitTransaction.

The value shall be used to initialize the contact less kernels and to determine if a certain POS entry mode is even possible. The ECR is allowed to not follow this indication and send another transaction type. This may lead the terminal application to do require a double tap or even terminate the transaction.

The following values area valid:

Guides: petrol, advancedRetail, banking, hospitality, valueAddedServices.

Guides

Flag constants for FeatureType and OptionType sixml:Guides value.

HardwareType

HardwareTypes are used to label hardware related data in the HardwareInformation response.

The following values are valid:

ImageFileFormat

KernelType

LoyaltyFunctionType

Defines what kind of loyalty mode will be used.

The are different modes that can be used with the LoyaltyData function.

The following values are valid:

Specification: valueAddedServices.

MaintenanceType

Type of maintenance process to perform.

Specification: remote.

ManagementStatus

MerchantAction

Constants for MerchantAction tag.

MerchantOptionType

Specifies type of merchant option.

The following values are valid:

MobileTopupType

Mobile Topup Transaction Type.

NgvMode

NonFinancialTransactions

Flag constants for FeatureType and OptionType sixml:NonFinancialTransactions value.

Guides: retail, valueAddedServices.

Outcome

Identifies the outcome of the previous transaction (in the TransactionInfoRequest response).

PaymentProtocol

Specifies the payment protocol used.

The following values are valid:

PosEntryMode

Defines how the cardholder used the card with the terminal for the transaction.

Enumeration according to EMV definition. The following values are valid:

PrintFlag

Constants for PrintFlag tag or&ed together.

PrintFormat

Constants for PrintFormat tag.

ProcessingDisposition

Defines if the ECR or EFT is responsible for further trx handling.

The following values are valid:

Specification: petrol.

ProtocolLevel

Protocol level for FeatureType and OptionType sixml:ProtocolLevel value.

ProtocolType

Protocol to use for communication.

Reason

Constants for Reason tag.

Specification: petrol.

ReceiptItemType

Specifies type of ReceiptItem.

This field has a freetext format, but the following values are predefined:

ReceiptRequestType

Constants for ReceiptRequestType tag.

ReceiptType

Specifies type of the receipt.

The following values are valid:

Recipient

Specifies the recipient of a receipt.

The following values are valid:

RemoteFunctions

Flag constants for FeatureType and OptionType sixml:RemoteFunctions value.

ResourceId

Enumeration attribute defines which dialog shall be displayed. All dialogs are divided into multiple groups containing dialogs similar operational area.

Specification: dialog.

ResourceParameterType

ResponseType

Defines the outcome type of the command response.

The following values are valid:

Specification: dialog.

ResultCode

Result codes.

Guides: retail, valueAddedServices.

SecurityStatus

Constants for SecurityStatus tag.

SettingType

Constants for SettingType tag.

SleepModeStatus

Constants for SleepModeStatus tag.

StatusFunctions

Flag constants for FeatureType and OptionType sixml:StatusFunctions value.

Theme

Defines the appearance of the dialog.

The following values are valid:

Specification: dialog.

ThirdPartyAppId

Identifier of a third party application.

Specification: valueAddedServices.

ThirdPartyApps

Flag constants for FeatureType and OptionType ThirdPartyApps value.

Specification: valueAddedServices.

TokenPanType

To differ the source of a token PAN, the TokenPanType field is used in a SIXml request message as part of the sixml:TransactionData container and in a SIXml response message as part of the sixml:CardData container.

The TokenPanType field always is transmitted if a TokenPan field is transmitted but must not be transmitted alone.

TransactionReason

Contains information on the purpose of the transaction and the credential on file establishment.

TransactionStatus

Information of the current transaction state.

This field is returned in the TerminalStatus notification to give the current transaction state from the terminal.

The following values are valid:

TransactionType

UpdateStatus

Contains the current software update status.

Used in the SoftwareUpdate response returned by the treminal.

The following values are valid:

VasInfoListType

Defines what kind of information will be available in the VasInformationList.

The following values are valid:

Specification: valueAddedServices.

VasInfoType

In This Article
  • Classes
  • Enums
Back to top Worldline AG