Enumerations

The following enumerations are available globally.

  • Errors thrown my Tim Api.

    See more

    Declaration

    Swift

    public enum Errors : Error, CustomStringConvertible

  • 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.

    See more

    Declaration

    Swift

    public enum CAdjustmentResult

  • Flag constants for FeatureType and OptionType sixml:AdminFunctions value.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CAdminFunctions

  • Brands that can be used in the BrandBar tag.

    Specification: dialog.

    See more

    Declaration

    Swift

    public enum CBrandBarBrand

  • 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.

    See more

    Declaration

    Swift

    public enum CBrandMode

  • Defines that shall be used for the card commands.

    The following values are valid:

    Specification: dialog.

    See more

    Declaration

    Swift

    public enum CCardReader

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

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CCardReaderStatus

  • Defines the type of connection between ECR and EFT Terminal.

    See more

    Declaration

    Swift

    public enum CConnectionMode

  • 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:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CConnectionStatus

  • 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:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CCounterType

  • Defines why a coupon has been rejected.

    The following values are valid:

    Specification: valueAddedServices.

    See more

    Declaration

    Swift

    public enum CCouponRejectionReason

  • Currency codes as enumeration. The raw value can be used as key for the currencyCode dictionary which contains additional information.

    See more

    Declaration

    Swift

    public enum CCurrency : String

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

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CCurrencyType

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

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CCustomerDataType

  • 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:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CCvm

  • Flag constants for FeatureType and OptionType sixml:DialogFunctions value.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CDialogFunctions

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

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CEcrInfoType

  • Flag constants for FeatureType and OptionType sixml:FinancialTransactions value.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CFinancialTransactions

  • Flag constants for FeatureType and OptionType sixml:Guides value.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CGuides

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

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CHardwareType

  • Defines the file format of the signature image.

    This field can either be used as attribute in the tag to define the file format of the signature image that is wished to be returned, or in the to specify the file format of the signature image that has actually been returned from the terminal.

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CImageFileFormat

  • Enumeration that specifies the type of kernel.

    This field is used as attribute of the tag to specify the type of the kernel accoring to EMV.

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CKernelType

  • 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.

    See more

    Declaration

    Swift

    public enum CLoyaltyFunctionType

  • The tag is used to transport information about the current activation state of the terminal, i.e. shift open / shift closed.

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CManagementStatus

  • Constants for MerchantAction tag.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CMerchantAction

  • Specifies type of merchant option.

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CMerchantOptionType

  • Defines if NGV usage is mandatory or optional if card supports it.

    This field can be set in a purchase transaction request to define the NGV behaviour for the current transaction.

    Example: NGV purchase transaction with one day clearing delay:

    The following values are valid:

    Specification: austrianUseCases.

    See more

    Declaration

    Swift

    public enum CNgvMode

  • Flag constants for FeatureType and OptionType sixml:NonFinancialTransactions value.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CNonFinancialTransactions

  • Constants for PaymentProtocol tag.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CPaymentProtocol

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

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

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CPosEntryMode

  • Constants for PrintFlag tag or&ed together.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CPrintFlag

  • Constants for PrintFormat tag.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CPrintFormat

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

    The following values are valid:

    Specification: petrol.

    See more

    Declaration

    Swift

    public enum CProcessingDisposition

  • Protocol level for FeatureType and OptionType sixml:ProtocolLevel value.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CProtocolLevel

  • Protocol to use for communication.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CProtocolType

  • Constants for Reason tag.

    Specification: dialog.

    See more

    Declaration

    Swift

    public enum CReason

  • Specifies type of ReceiptItem.

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

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CReceiptItemType

  • Constants for ReceiptRequestType tag.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CReceiptRequestType

  • Specifies type of the receipt.

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CReceiptType

  • Specifies the recipient of a receipt.

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CRecipient

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

    The dialog description contains the following elements:

    Element Description
    Value Unique dialog number.
    PrimaryIcon The primary icon that shall be displayed during the dialog.
    SecondaryIcon The secondary icon that shall be displayed during the dialog.
    Text The text for the dialog.
    Placeholder Placeholder element that shall be replaced by the corresponding value.
    InputMask Defines the input format. d = digit, h = hidden digit
    ActiveConfirmation The active pinpad and/or displayed button that shall be active during the dialog.
    SigCapFlag Indicates if the dialog can be used for signature capturing.

    An InputMask with “h” = hidden digit means that the input must not be displayed in plain text but must be hidden e.g. using “*” instead of plain text.

    The following groups are defined:

    Group Description
    0xxx Petrol dialogs
    1000-1099 Post dialogs
    1100-1200 Banking dialogs
    2xxx Unattended dialogs
    3xxx AT dialogs

    Petrol Dialogs. The following petrol dialogs are valid:

    Value PrimaryIcon SecondaryIcon Text Placeholder InputMask ActiveConfirmation ResourceParameter
    0100 PinPad - Enter mileage + OK
    %i    		 - dddddddd Ok, Stop -
    0101 PinPad - Enter your car number + OK
    %i    		 - dddddd Ok, Stop -
    0102 PinPad - Enter drivercode + OK
    %i    		 - dddddd Ok, Stop -
    0103 PinPad - Enter fleet ID + OK
    %i    		 - dddddd Ok, Stop -
    0104 PinPad - %0 %1
    Please select pump: %i
    + OK
    • 0: Currency (optional)
    • 1: Amount (optional)
    		 dd Ok, Stop -
    0105 PinPad - Please select washing
    station: %i + OK    		 - dd Ok, Stop -
    0106 PinPad - Please select program:
    %i + OK    		 - dd Ok, Stop -
    0107 PinPad - Please select product:
    %i + OK    		 - dd Ok, Stop -
    0108 PinPad - Load card
    Amount: %i + OK    		 - dd Ok, Stop -
    0109 PinPad - Tankcode?
    %i    		 - hhhhhhhhhhhh Ok, Stop -
    0110 PinPad - CODE & OK?
    %c    		 - hhhhhhhhhhhh Ok, Stop
    • CodeCheckType
    • CodeCheckKeyId (optional)
    • CodeCheckData (optional)
    • PetrolCardData1 (optional)
    • PetrolCardData2 (optional)
    • PetrolCardData3 (optional)
    0111 PinPad - Enter additional information + OK
    %i    		 - dddddddddddddddddddd Ok, Stop -
    0112 PinPad - Enter cost center + OK
    %i    		 - dddddddddddddddddddd Ok, Stop -
    0113 PinPad - Enter employee no + OK
    %i    		 - dddddddddddddddddddd Ok, Stop -
    0114 PinPad - Enter license plate + OK
    %i    		 - dddddddddddddddddddd Ok, Stop -
    0115 PinPad - Enter project no + OK
    %i    		 - dddddddddddddddddddd Ok, Stop -
    0116 - - Print receipt?
    YES / NO
    		 - - Ok, Stop -
    0117 RemoveCard - Remove card - - CardReader -
    0118 - - Out of order - - Ok, Stop -
    0119 - - Invalid entry - - Ok, Stop -
    0120 - - Please refuel at
    dispenser %0
    • 0: Dispenser number (n2, mandatory)
    		 - Ok, Stop -
    0121 - - Please consider
    main screen
    		 - - Ok, Stop -
    0122 - - Please refuel - - - -
    0123 - - Please refuel for
    %0 %1
    • 0: Currency (an, mandatory) (e.g. EUR)
    • 1: Amount (n, mandatory) (e.g. 45.00)
    		 - - -

    Note: Dialog 0110 is not supposed to return the input value, but shall check the code according to the CodeCheckType and return the result in the Reason . CodeOk for success and CodeNok for failure.

    Postal Dialogs. The following postal dialogs are valid:

    Value PrimaryIcon SecondaryIcon Text Placeholder InputMask ActiveConfirmation SigCapFlag
    1000 - - Keine Recharge
    Karte    		 - - Ok
    • 0: not allowed in SignatureCapture
    • 1: allowed
    1001 MobilePhone - %0
    %1 %2
    • 0: phone number
    • 1: Currency
    • 2: Amount
    		 - Ok, Stop 0
    1002 PinPad Card Bitte Tel. Nummer
    oder PrePaid-Karte
    %i    		 - ddd ddd
    dd dd    		 Ok, Stop, CardReader 0
    1003 - - Tel. Nummer zu lang - - Ok, Stop 0
    1004 - - Tel. Nummer zu kurz - - Ok, Stop 0
    1005 PinPad - Bitte
    Telefonnummer
    eingeben
    %i    		 - ddd ddd
    dd dd    		 Ok, Stop 0
    1006 PleaseWait - Bitte warten - - - 0
    1007 Declined - Verarbeitung
    fehlgeschlagen    		 - - Ok 0
    1008 Ok - Verarbeitung OK - - Ok 0
    1009 - - Karte anmelden - - Ok, Stop 0
    1010 InsertCard - Willkommen,
    Karte bitte    		 - - CardReader 0
    1011 PinPad - Ihre
    Telefonnummer
    lautet %0
    • 0: phone number
    		 - Ok, Stop 0
    1012 - - Von %0 %1 %2
    %3
    auf %4 %5 %6
    %7
    %8 %9
    • 0: LastKonto
    • 1: LastKontoTyp
    • 2: Currency LastKonto
    • 3: LastKonto-Bezeichnung
    • 4: GutsKonto
    • 5: GutsKontoTyp
    • 6: Currency Gutskonto
    • 7: GutsKonto-Bezeichnung
    • 8: Currency
    • 9: Amount
    		 - Ok, Stop 0
    1013 - - %0 %1 %2
    %3 %4
    %5 %6 %7
    %8 %9
    • 0: LastKonto
    • 1: LastKontoTyp
    • 2: Currency LastKonto
    • 3: Currency
    • 4: AmountSaldo
    • 5: GutsKonto
    • 6: GutsKontoTyp
    • 7: Currency GutsKonto
    • 8: Currency
    • 9: AmountSaldo
    		 - Ok 0
    1014 - - Bezug ab Konto
    %0
    %1 %2 OK?
    • 0: Debit Account
    • 1: Debit Currency
    • 2: Amount
    		 - Ok, Stop 0
    1015 - - Einz. auf eigenes Kto
    Autorisierung
    %0 %1 OK?
    • 0: Currency
    • 1: Amount
    		 - Ok, Stop 0
    1016 - - - - - Ok, Stop 1
    1017 - - Ich habe die
    Sendungen und
    die darauf
    aufgeführten
    Inhalte erhalten    		 - - Ok, Stop 1
    1018 PinPad - Bitte PIN
    eingeben:
    %i    		 - hhhhhh Ok, Stop 0

    Banking Dialogs. The following banking dialogs are valid:

    Value PrimaryIcon SecondaryIcon Text Placeholder InputMask ActiveConfirmation SigCapFlag ResourceParameter
    1100 InsertCard - Welcome
    card please    		 - - CardReader 0 -
    1101 PinPad - PIN & OK
    %i    		 - hhhhhh Ok, Stop 0 -
    1102 PinPad - Press key
    to show saldo    		 0: Currency 1: Amount - Ok, Stop 0 -
    1103 PinPad - Confirm amount
    %2
    %0 %1
    • 0: Currency
    • 1: Amount
    • 2: Time and Date (optional)
    		 - Ok, Stop 0 -
    1104 RemoveCard - Remove card - - CardReader 0 -
    1105 InsertCard - Welcome
    card please    		 - - - 0 -

    AT Dialogs. The following at dialogs are valid:

    Value PrimaryIcon SecondaryIcon Text Placeholder InputMask ActiveConfirmation SigCapFlag ResourceParameter
    3000 InsertCard - Stammkundenabfrage - - CardReader, Stop 0
    • RegularDataQueryType
    3001 PleaseWait - Bitte warten - - Stop 0 -
    3002 - - Daten geschrieben - - Ok 0 -
    3003 - - Karte initialisiert - - Ok 0 -
    3004 - - Karte deinitialisiert - - Ok 0 -
    3005 RemoveCard - Karte entnehmen - - CardReader 0 -

    Specification: dialog.

    See more

    Declaration

    Swift

    public enum CResourceId

  • Parameter type

    Classifies the value of the tag.

    The following values are valid:

    Specification: dialog.

    See more

    Declaration

    Swift

    public enum CResourceParameterType

  • Defines the outcome type of the command response.

    The following values are valid:

    Specification: dialog.

    See more

    Declaration

    Swift

    public enum CResponseType

  • Result codes.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CResultCode

  • Constants for SecurityStatus tag.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CSecurityStatus

  • Constants for SettingType tag.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CSettingType

  • Constants for SleepModeStatus tag.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CSleepModeStatus

  • Flag constants for FeatureType and OptionType sixml:StatusFunctions value.

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CStatusFunctions

  • Defines the appearance of the dialog.

    The following values are valid:

    Specification: dialog.

    See more

    Declaration

    Swift

    public enum CTheme

  • 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:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CTransactionStatus

  • Defines the type of transaction.

    Used as attribute to classify the transaction in the field.

    The following values are valid:

    Specifications: retail, petrol, advancedRetail, banking, hospitality, valueAddedServices.

    See more

    Declaration

    Swift

    public enum CTransactionType

  • Contains the current software update status.

    Used in the SoftwareUpdate response returned by the treminal.

    The following values are valid:

    Specification: retail.

    See more

    Declaration

    Swift

    public enum CUpdateStatus