TIM API JavaScript Documentation: Class: TransactionData

Overview

Members-Overview

acqId	:Number
acqTransRef	:String
ageToCheck	:Number
allowedAccounts	:Set.<timapi.constants.AllowedAccounts>
appExpirationDate	:timapi.TimeDate
authCode	:String
cardRef	:String
cvc2	:Number
dccAllowed	:Boolean
deferredAuthInd	:Boolean
ecrSeqCounter	:Number
installmentAllowed	:Boolean
language	:String
multiCurrencyFlag	:Boolean
ngvClearingDelay	:Number
ngvMode	:timapi.constants.NgvMode
partialApprovalAllowed	:Boolean
phoneAuthCode	:String
sixTrxRefNum	:String
subTransactions	:Array.<timapi.SubTransactions>
tipAllowed	:Boolean
tokenPan	:String
tokenPanType	:timapi.constants.TokenPanType
transRef	:Number
transSeq	:Number
trmTransRef	:String
trxOriginalDate	:timapi.TimeDate

Methods-Overview

setAcqTransRef(acqId, trxRefNo)
setSixTrxRefNum()
toString() → {String}
copy(transactionData) → {timapi.TransactionData}

Constructor

new TransactionData()

Create empty TransactionData. If copyTrxData is not undefined initializes values with values from copyTrxData.

Member-List

acqId :Number

Acquirer identifier. Uniquely identifies the acquirer. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal

Forbidden (has to be always undefined):

timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.initTransaction
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.unload

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

acqTransRef :String

Transaction Reference generated by the acquirer, therefore only valid in the context of the same acquirer. Mandatory for (can not be undefined):

timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.unload

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal

Forbidden (has to be always undefined):

timapi.constants.TransactionType.initTransaction

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

ageToCheck :Number

Age to check. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.reservation

Forbidden (has to be always undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload
timapi.constants.TransactionType.initTransaction

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

allowedAccounts :Set.<timapi.constants.AllowedAccounts>

Allowed accounts. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.credit
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseWithCashback

Forbidden (has to be always undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.balanceInquiry
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

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

appExpirationDate :timapi.TimeDate

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 undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.purchaseReservation

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

authCode :String

If the underlying payment protocol supports/requests it, for referencing a previous transaction that shall be refunded. Mandatory for (can not be undefined):

timapi.constants.TransactionType.credit

Conditional for (can be undefined):

Forbidden (has to be always undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.unload
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.reversal

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

cardRef :String

Card Reference Number (aka. Token) generated by the termianl to identify the card. Only valid on this terminal. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.preAuthorization

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

cvc2 :Number

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 undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.initTransaction
timapi.constants.TransactionType.purchaseReservation

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

dccAllowed :Boolean

Allows the EFT Terminal to enable DCC function. Use undefined to not use this parameter. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.reservation

Forbidden (has to be always undefined):

timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.initTransaction
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

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

deferredAuthInd :Boolean

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 undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

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

ecrSeqCounter :Number

ECR sequence counter. Use undefined to not use this parameter. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.initTransaction

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

installmentAllowed :Boolean

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 undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.initTransaction

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

language :String

Petrol, Unattended: Language. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.balanceInquiry
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.clientIdentification
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.initTransaction
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.sendCardCommand
timapi.constants.TransactionType.startCheckout
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.reversal

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

multiCurrencyFlag :Boolean

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 undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

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

ngvClearingDelay :Number

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 ngvMode is undefined. Available if guide austrianUseCases is enabled. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

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

ngvMode :timapi.constants.NgvMode

Defines if NGV usage is mandatory or optional if card supports it. Available if guide austrianUseCases is enabled. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

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

partialApprovalAllowed :Boolean

Partial approval is allowed. Use undefined to not use this parameter. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.reservation

Forbidden (has to be always undefined):

timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.initTransaction
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

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

phoneAuthCode :String

Phone authorization code. Mandatory for (can not be undefined):

timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.reservation

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

sixTrxRefNum :String

Universal Transaction Reference valid in the whole Worldline unverse including Saferpay.

subTransactions :Array.<timapi.SubTransactions>

Sub transactions. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.combined

Forbidden (has to be always undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

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

tipAllowed :Boolean

Tip is allowed for purchase transactions. Use undefined to not use this parameter. This parameter is only used if guide gastro is enabled. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.reservation

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

tokenPan :String

The token PAN is a tokenized version for an underlaying 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 in a SIXml request message as part of the sixml:TransactionData container to trigger a token-based transaction and in a SIXml response message as part of the sixml:CardData container for returning token PANs to the ECR. The TokenPan field always must be accompanied by a corresponding TokenPanType field. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.reversal

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

tokenPanType :timapi.constants.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. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.reversal

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

transRef :Number

Transaction reference defined by the terminal. Use undefined to not use this parameter. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.load
timapi.constants.TransactionType.refunding

Forbidden (has to be always undefined):

timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.initTransaction
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

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

transSeq :Number

Transaction sequence number defined by the terminal. Use undefined to not use this parameter. Mandatory for (can not be undefined):

timapi.constants.TransactionType.reversal

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.finalizePurchase

Forbidden (has to be always undefined):

timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.initTransaction
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.unload

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

trmTransRef :String

Transaction Reference generated by the trminal, therefore only valid on this terminal. Mandatory for (can not be undefined):

timapi.constants.TransactionType.finalizePurchase

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.load
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.refunding
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

Forbidden (has to be always undefined):

timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.initTransaction
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized

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

trxOriginalDate :timapi.TimeDate

Timestamp of the original transaction. Use undefined to not use this parameter. Mandatory for (can not be undefined):

Conditional for (can be undefined):

timapi.constants.TransactionType.accountVerification
timapi.constants.TransactionType.authorizeCredit
timapi.constants.TransactionType.credit
timapi.constants.TransactionType.load
timapi.constants.TransactionType.refunding

Forbidden (has to be always undefined):

timapi.constants.TransactionType.activateCard
timapi.constants.TransactionType.adjustReservation
timapi.constants.TransactionType.authorizeDeposit
timapi.constants.TransactionType.cancelReservation
timapi.constants.TransactionType.cashAdvance
timapi.constants.TransactionType.collectPoints
timapi.constants.TransactionType.combined
timapi.constants.TransactionType.debtRecovery
timapi.constants.TransactionType.finalizePurchase
timapi.constants.TransactionType.funding
timapi.constants.TransactionType.giro
timapi.constants.TransactionType.initTransaction
timapi.constants.TransactionType.loadVoucher
timapi.constants.TransactionType.preAuthorization
timapi.constants.TransactionType.purchase
timapi.constants.TransactionType.purchaseForcedAcceptance
timapi.constants.TransactionType.purchaseMailOrdered
timapi.constants.TransactionType.purchasePhoneAuthorized
timapi.constants.TransactionType.purchasePhoneOrdered
timapi.constants.TransactionType.purchaseReservation
timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
timapi.constants.TransactionType.purchaseWithCashback
timapi.constants.TransactionType.reservation
timapi.constants.TransactionType.reversal
timapi.constants.TransactionType.unload

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

Methods

setAcqTransRef(acqId, trxRefNo)

Set transaction reference from the acquirer. This method is to be used only for manual entry by clerks for EP2 hospitality transactions only. The usual use case is to directly set the property with the reference string acquired from a previous transaction.

Parameters:

Name	Type	Description
`acqId`	Number	Acquirer ID as printed on receipt.
`trxRefNo`	Number	Transaction reference as printed on receipt.

setSixTrxRefNum()

SIX Transaction Reference Number for integrators using MPD Client.

toString() → {String}

String representation for debugging purpose.

Returns:

String representation

Type: String

(static) copy(transactionData) → {timapi.TransactionData}

Creates a copy of an timapi.TransactionData object

Parameters:

Name	Type	Description
`transactionData`	timapi.TransactionData	Original

Returns:

Copy of original

Type: timapi.TransactionData