TIM SDK
TIM API C#

Class TransactionData

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

Inheritance
System.Object
TransactionData
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: SIX.TimApi
Assembly: TimApi.dll
Syntax
public class TransactionData

Constructors

TransactionData()

Create transaction data.

Declaration
public TransactionData()

TransactionData(TransactionData)

Create copy of transaction data

Declaration
public TransactionData(TransactionData data)
Parameters
Type Name Description
TransactionData data

The TransactionData to copy.

Properties

AcqId

Acquirer identifier. Uniquely identifies the acquirer.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.InitTransaction
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public long AcqId { get; set; }
Property Value
Type Description
System.Int64

AcqTransRef

Contains the transaction reference from the acquirer.

Mandatory for (can not be null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Unload

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.InitTransaction

Transactions will fail if one of the above mentioned restrictions are violated.

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

AllowedAccounts

Allowed accounts.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.BalanceInquiry
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public List<AllowedAccounts> AllowedAccounts { get; set; }
Property Value
Type Description
System.Collections.Generic.List<AllowedAccounts>

AppExpirationDate

Application expiration date. Each application on a card has a corresponding expiration date and can be read from the card. Example: The format of an 'Expiration Date' is defined as MMyy, 2 digits for the month and 2 digits for the year. So January 2018 will have the following format as 'Expiration Date': 0118 Optional: Used for MPKE for non-PCI brands based transactions.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public DateTime? AppExpirationDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

CardRef

Petrol: Reference from the card.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.PreAuthorization

Transactions will fail if one of the above mentioned restrictions are violated.

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

Cvc2

Card verification code 2. The card verification code 2 is used for transactions with MPKE as an additional security element that has to be provided. It has an n3 value: Numeric 3 digits: 012 Optional: Used for MPKE for non-PCI brands.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.InitTransaction
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public long? Cvc2 { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

DccAllowed

Set or read if the EFT Terminal is allowed to enable DCC function.

If not specified by the EFT false is returned. Deprecated! Use DccAllowedNullable instead since this property can return null value if not set.

Declaration
[Obsolete("Use DccAllowedNullable instead since this property can return null value if not set.")]
public bool DccAllowed { get; set; }
Property Value
Type Description
System.Boolean

DccAllowedNullable

Set or read if the EFT Terminal is allowed to enable DCC function.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Reservation

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.InitTransaction
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public bool? DccAllowedNullable { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

DeferredAuthInd

Indicates that the transaction shall be performed using deffered authorisation. The following values are valid: true: Deferred authorisation applies false: Standard authorisation scheme (default)

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public bool? DeferredAuthInd { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

EcrSeqCounter

Declaration
[Obsolete("Use EcrSeqCounterNullable instead since this property can return null value if not set.")]
public int EcrSeqCounter { get; set; }
Property Value
Type Description
System.Int32

EcrSeqCounterNullable

ECR sequence counter or null if not set.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.InitTransaction

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public int? EcrSeqCounterNullable { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

InstallmentAllowed

Indicates if installment shall be allowed for a transaction. This tag can be set for each transaction separately to specifically allow or disallow installment feature during the corresponding transaction. As this is a boolean value is can be understood as follows: true: Installment is allowed for the transaction false: Installment is NOT allowed for the transaction

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.InitTransaction

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public bool? InstallmentAllowed { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Language

the language. (Petrol, Unattended)

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.BalanceInquiry
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.ClientIdentification
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.InitTransaction
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.SendCardCommand
  • SIX.TimApi.Constants.TransactionType.StartCheckout
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Reversal

Transactions will fail if one of the above mentioned restrictions are violated.

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

MultiCurrencyFlag

Indicates if the transaction uses multiple currencies.

Optional: Indicates that the transaction uses multiple currencies.

Specifications: banking, gastro, hospitality,austrianUseCases.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

Transactions will fail if one of the above mentioned restrictions are violated.

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

NGVClearingDelay

Defines the clearing delay of the PurchaseNGV transaction.

The following values are currently defined:

Value Description
0 no delay
1-99 delay in days

Not used if getNgvMode() is null.

Available if {@link Guides#AUSTRIAN_USE_CASES} is enabled.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public int NGVClearingDelay { get; set; }
Property Value
Type Description
System.Int32

NGVMode

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

Set to null if not used.

Available if {@link Guides#AUSTRIAN_USE_CASES} is enabled.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public NgvMode NGVMode { get; set; }
Property Value
Type Description
NgvMode

OmnichannelMerchantId

The OmnichannelMerchantId is used to identify the merchant on a Omnichannel host. This field is not used for Saferpay, but is for example for Ogone.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.Credit

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

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

OmnichannelPaymentId

Reference to an Omnichannel transaction. Can be used for example for the use case "click and return", where a transaction originating in the e-commerce channel (e.g. Ogone) can be refunded via TIM API, by setting the e-commerce payment-id as OmnichannelPaymentId. (Note: This does not apply for Saferpay, for Saferpay use "SixTrxRefNum")

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.Credit

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

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

PartialApprovalAllowed

Partial approval is allowed.

If not specified by the EFT false is returned. Deprecated! Use PartialApprovalAllowedNullable instead since this property can return null value if not set.

Declaration
[Obsolete("Use PartialApprovalAllowedNullable instead since this property can return null value if not set.")]
public bool PartialApprovalAllowed { get; set; }
Property Value
Type Description
System.Boolean

PartialApprovalAllowedNullable

Partial approval is allowed.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Reservation

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.InitTransaction
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public bool? PartialApprovalAllowedNullable { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

PhoneAuthCode

Phone authorization code.

Mandatory for (can not be null):

  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Reservation

Transactions will fail if one of the above mentioned restrictions are violated.

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

SaferpayAlias

Saferpay alias..

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

SaferpayRecurring

Saferpay recurring enabled.

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

SixTrxRefNum

SIX Transaction reference number.

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

SubTransactions

Sub transactions.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.Combined

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public List<SubTransaction> SubTransactions { get; set; }
Property Value
Type Description
System.Collections.Generic.List<SubTransaction>

TipAllowed

Tip is allowed for purchase transactions. Use null to not use this parameter.

This parameter is only used if {@link com.six.timapi.constants.Guides#GASTRO} is enabled.

If not specified by the EFT false is returned. Deprecated! Use TipAllowedNullable instead since this property can return null value if not set.

Declaration
[Obsolete("Use TipAllowedNullable instead since this property can return null value if not set.")]
public bool TipAllowed { get; set; }
Property Value
Type Description
System.Boolean

TipAllowedNullable

Tip is allowed for purchase transactions. Use null to not use this parameter.

This parameter is only used if {@link com.six.timapi.constants.Guides#GASTRO} is enabled.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.Reservation

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public bool? TipAllowedNullable { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

TokenPan

The token PAN is a tokenized version for an underlying card PAN. If the underlaying payment protocol supports it, a payment transaction can be initiated with the token PAN instead of using a card. A token PAN is normally generated by a tokenization service either form the acquirer host or the issuer host.

The TokenPan field is used to trigger a token-based transaction. Note: The TokenPanType must also be given

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.Reversal

Transactions will fail if one of the above mentioned restrictions are violated.

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

TokenPanType

To differ the source of a token PAN, the TokenPanType field is used. Only used in combination with TokenPan.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.Reversal

Transactions will fail if one of the above mentioned restrictions are violated.

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

TransactionReason

Set the transaction reason to setup credential on file.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.InitTransaction

Transactions will fail if one of the above mentioned restrictions are violated.

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

TransRef

Get/Set transaction reference defined by the terminal.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.Refunding

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.InitTransaction
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

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

TransSeq

Get/Set transaction sequence number defined by the terminal.

Mandatory for (can not be null):

  • SIX.TimApi.Constants.TransactionType.Reversal

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.InitTransaction
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

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

TrmTransRef

transaction reference from the terminal.

Mandatory for (can not be null):

  • SIX.TimApi.Constants.TransactionType.FinalizePurchase

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.InitTransaction
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized

Transactions will fail if one of the above mentioned restrictions are violated.

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

TrxOriginalDate

Timestamp of the original transaction.

If not specified by the EFT DateTime.MinValue is returned. Deprecated! Use TrxOriginalDateNullable instead since this property can return null value if not set.

Declaration
[Obsolete("Use TrxOriginalDateNullable instead since this property can return null value if not set.")]
public DateTime TrxOriginalDate { get; set; }
Property Value
Type Description
System.DateTime

TrxOriginalDateNullable

Timestamp of the original transaction.

Mandatory for (can not be null):

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.Refunding

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.InitTransaction
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal
  • SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public DateTime? TrxOriginalDateNullable { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Methods

setAcqTransRef(Int64, Int32)

Set transaction reference from the acquirer.

This method is to be used only for manual entry by clerks for EP2 hospitality transactions only.

Acquirer ID as printed on receipt. trxRefNo Transaction reference as printed on receipt.

Mandatory for (can not be null):

  • SIX.TimApi.Constants.TransactionType.AdjustReservation
  • SIX.TimApi.Constants.TransactionType.CancelReservation
  • SIX.TimApi.Constants.TransactionType.DebtRecovery
  • SIX.TimApi.Constants.TransactionType.PurchaseReservation
  • SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.Refunding
  • SIX.TimApi.Constants.TransactionType.Unload

Conditional for (can be null):

  • SIX.TimApi.Constants.TransactionType.AccountVerification
  • SIX.TimApi.Constants.TransactionType.ActivateCard
  • SIX.TimApi.Constants.TransactionType.AuthorizeCredit
  • SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
  • SIX.TimApi.Constants.TransactionType.CashAdvance
  • SIX.TimApi.Constants.TransactionType.CollectPoints
  • SIX.TimApi.Constants.TransactionType.Combined
  • SIX.TimApi.Constants.TransactionType.Credit
  • SIX.TimApi.Constants.TransactionType.FinalizePurchase
  • SIX.TimApi.Constants.TransactionType.Funding
  • SIX.TimApi.Constants.TransactionType.Giro
  • SIX.TimApi.Constants.TransactionType.Load
  • SIX.TimApi.Constants.TransactionType.LoadVoucher
  • SIX.TimApi.Constants.TransactionType.PreAuthorization
  • SIX.TimApi.Constants.TransactionType.Purchase
  • SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
  • SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
  • SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
  • SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
  • SIX.TimApi.Constants.TransactionType.Reservation
  • SIX.TimApi.Constants.TransactionType.Reversal

Forbidden (has to be always null):

  • SIX.TimApi.Constants.TransactionType.InitTransaction

Transactions will fail if one of the above mentioned restrictions are violated.

Declaration
public void setAcqTransRef(long acqId, int trxRefNo)
Parameters
Type Name Description
System.Int64 acqId
System.Int32 trxRefNo

setSixTrxRefNum(Int64, String)

Set SIX Transaction Reference Number for integrators using MPD Client.

Declaration
public void setSixTrxRefNum(long acqId, string trxRefNum)
Parameters
Type Name Description
System.Int64 acqId
System.String trxRefNum

ToString()

String representation.

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()