Class: TransactionInformation

timapi.TransactionInformation

Contains information about a finished transaction after calling the timapi.Terminal or timapi.Terminal. Immutable class.

Overview

Members-Overview

Methods-Overview

Member-List

accountNumber :String

Account number of the card used.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

Conditional for (can be undefined):
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.authorizeDeposit
  • timapi.constants.TransactionType.cashAdvance
  • timapi.constants.TransactionType.combined
  • timapi.constants.TransactionType.credit
  • timapi.constants.TransactionType.giro
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.reversal
Otherwise Forbidden (always undefined)

acqId :Number

Acquirer identifier. Conditional for (can be undefined):
  • timapi.constants.TransactionType.activateCard
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.authorizeDeposit
  • timapi.constants.TransactionType.cashAdvance
  • 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.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.reversal
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification
  • timapi.constants.TransactionType.adjustReservation
  • timapi.constants.TransactionType.cancelReservation
  • timapi.constants.TransactionType.collectPoints
  • timapi.constants.TransactionType.loadVoucher
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.reservation

acqTransRef :String

Transaction Reference generated by the acquirer, therefore only valid in the context of the same acquirer. Mandatory for:
  • timapi.constants.TransactionType.adjustReservation
  • timapi.constants.TransactionType.cancelReservation
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.reservation
Conditional for (can be undefined):
  • 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.loadVoucher
  • timapi.constants.TransactionType.load
  • timapi.constants.TransactionType.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification
  • timapi.constants.TransactionType.reversal

ageCheckResult :timapi.constants.AgeCheckResult

Age check result. Conditional for (can be undefined):
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.preAuthorization
  • timapi.constants.TransactionType.reversal
Forbidden (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.loadVoucher
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.reservation
  • timapi.constants.TransactionType.unload
  • timapi.constants.TransactionType.accountVerification
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.credit
  • timapi.constants.TransactionType.load
  • timapi.constants.TransactionType.refunding

authCode :String

Authorization code received from the acquirer. Conditional for (can be undefined):
  • timapi.constants.TransactionType.activateCard
  • timapi.constants.TransactionType.adjustReservation
  • 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.loadVoucher
  • timapi.constants.TransactionType.load
  • timapi.constants.TransactionType.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.reservation
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification
  • timapi.constants.TransactionType.cancelReservation
  • timapi.constants.TransactionType.reversal

cardholderName :String

Cardholder name.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

Deprecated:
  • use CardData.cardholder instead.

cardId :String

Card ID.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

clientIdentifier :String

Cardholder ID- or Passport number.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

Conditional for (can be undefined):
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.authorizeDeposit
  • timapi.constants.TransactionType.cashAdvance
  • timapi.constants.TransactionType.combined
  • timapi.constants.TransactionType.credit
  • timapi.constants.TransactionType.giro
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.reversal
Otherwise Forbidden (always undefined)

cvm :timapi.constants.Cvm

Cardholder verification method. Conditional for (can be 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.loadVoucher
  • timapi.constants.TransactionType.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.reservation
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.credit
  • timapi.constants.TransactionType.load
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.reversal

merchantAction :timapi.constants.MerchantAction

Feedback to know which merchant action has to be performed. Mandatory for:
  • 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.loadVoucher
  • timapi.constants.TransactionType.load
  • timapi.constants.TransactionType.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.reservation
  • timapi.constants.TransactionType.reversal
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification

ngvUsedFlag :Boolean

Indicates if a transaction was performed as non guaranteed payment (NGV). Available if guide austrianUseCases is enabled.

omnichannelPaymentId

Omnichannel payment / transaction identifier.

Optional: Mandatory if available to terminal.

Specifications: retail, banking, austrianUseCases.

personOid :Number

Person OID.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

Conditional for (can be undefined):
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.authorizeDeposit
  • timapi.constants.TransactionType.cashAdvance
  • timapi.constants.TransactionType.combined
  • timapi.constants.TransactionType.credit
  • timapi.constants.TransactionType.giro
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.reversal
Otherwise Forbidden (always undefined)

posEntryMode :timapi.constants.PosEntryMode

According to EMV definition. Mandatory for:
  • 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.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.unload
Conditional for (can be undefined):
  • timapi.constants.TransactionType.adjustReservation
  • timapi.constants.TransactionType.finalizePurchase
  • timapi.constants.TransactionType.loadVoucher
  • timapi.constants.TransactionType.preAuthorization
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.reservation
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification
  • timapi.constants.TransactionType.cancelReservation
  • timapi.constants.TransactionType.reversal

schemeTrxId

Used for "Stored Credential" and the "Merchant-Initiated-Transaction (MIT) frameworks. Card scheme data element that links original authorisation requests to subsequent messages.

Used also for Initial recurring and omnichannel use cases.

Optional: Mandatory if available to terminal.

Specifications: retail, banking, austrianUseCases.

signatureInformation :timapi.SignatureInformation

Signature captured by EFT Terminal if present. Mandatory for:
  • timapi.constants.TransactionType.loadVoucher
Conditional for (can be undefined):
  • timapi.constants.TransactionType.activateCard
  • timapi.constants.TransactionType.adjustReservation
  • 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.funding
  • timapi.constants.TransactionType.giro
  • timapi.constants.TransactionType.load
  • timapi.constants.TransactionType.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.reservation
  • timapi.constants.TransactionType.reversal
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.collectPoints

sixTrxRefNum :String

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

timeStamp :timapi.TimeDate

Local time of the transaction. Mandatory for:
  • 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.loadVoucher
  • timapi.constants.TransactionType.load
  • timapi.constants.TransactionType.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.reservation
  • timapi.constants.TransactionType.reversal
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification

transRef :Number

Transaction reference defined by the terminal. Conditional for (can be undefined):
  • timapi.constants.TransactionType.activateCard
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.authorizeDeposit
  • timapi.constants.TransactionType.cashAdvance
  • 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.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.reversal
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification
  • timapi.constants.TransactionType.adjustReservation
  • timapi.constants.TransactionType.cancelReservation
  • timapi.constants.TransactionType.collectPoints
  • timapi.constants.TransactionType.loadVoucher
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.reservation

transSeq :Number

Transaction sequence number defined by the terminal. Conditional for (can be undefined):
  • timapi.constants.TransactionType.activateCard
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.authorizeDeposit
  • timapi.constants.TransactionType.cashAdvance
  • 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.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.reversal
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification
  • timapi.constants.TransactionType.adjustReservation
  • timapi.constants.TransactionType.cancelReservation
  • timapi.constants.TransactionType.collectPoints
  • timapi.constants.TransactionType.loadVoucher
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.reservation

trmTransRef :String

Transaction Reference generated by the terminal, therefore only valid on this terminal. Mandatory for:
  • timapi.constants.TransactionType.adjustReservation
  • timapi.constants.TransactionType.cancelReservation
  • timapi.constants.TransactionType.collectPoints
  • timapi.constants.TransactionType.purchaseReservationPhoneAuthorized
  • timapi.constants.TransactionType.purchaseReservation
  • timapi.constants.TransactionType.reservation
Conditional for (can be undefined):
  • timapi.constants.TransactionType.activateCard
  • timapi.constants.TransactionType.authorizeCredit
  • timapi.constants.TransactionType.authorizeDeposit
  • timapi.constants.TransactionType.cashAdvance
  • 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.loadVoucher
  • timapi.constants.TransactionType.load
  • timapi.constants.TransactionType.preAuthorization
  • timapi.constants.TransactionType.purchaseForcedAcceptance
  • timapi.constants.TransactionType.purchaseMailOrdered
  • timapi.constants.TransactionType.purchasePhoneAuthorized
  • timapi.constants.TransactionType.purchasePhoneOrdered
  • timapi.constants.TransactionType.purchaseWithCashback
  • timapi.constants.TransactionType.purchase
  • timapi.constants.TransactionType.refunding
  • timapi.constants.TransactionType.reversal
  • timapi.constants.TransactionType.unload
Forbidden (always undefined):
  • timapi.constants.TransactionType.accountVerification

Methods

toString() → {String}

String representation for debugging purpose.
Returns:
String representation

Type: String