Class: TransactionData

timapi.TransactionData()

Contains configuration for transaction used by timapi.Terminal or timapi.Terminal.

Overview

Members-Overview

Methods-Overview

Constructor

new TransactionData()

Create empty TransactionData.

Member-List

acqId :Number

Acquirer identifier. Uniquely identifies the acquirer.

acqTransRef :String

Transaction Reference generated by the acquirer, therefore only valid in the context of the same acquirer.

cardRef :String

Card Reference Number (aka. Token) generated by the termianl to identify the card. Only valid on this terminal.

dccAllowed :Boolean

Allows the EFT Terminal to enable DCC function. Use undefined to not use this parameter.

ecrSeqCounter :Number

ECR sequence counter. Use undefined to not use this parameter.

language :String

Petrol, Unattended: Language.

multiCurrencyFlag :Boolean

Indicates if the transaction uses multiple currencies.

Optional: Indicates that the transaction uses multiple currencies.

Specifications: banking, gastro, hospitality, austrianUseCases.

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.

ngvMode :timapi.constants.NgvMode

Defines if NGV usage is mandatory or optional if card supports it. Available if guide austrianUseCases is enabled.

partialApprovalAllowed :Boolean

Partial approval is allowed. Use undefined to not use this parameter.

phoneAuthCode :String

Phone authorization code.

sixTrxRefNum :String

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

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.

transRef :Number

Transaction reference defined by the terminal. Use undefined to not use this parameter.

transSeq :Number

Transaction sequence number defined by the terminal. Use undefined to not use this parameter.

trmTransRef :String

Transaction Reference generated by the trminal, therefore only valid on this terminal.

trxOriginalDate :timapi.TimeDate

Timestamp of the original transaction. Use undefined to not use this parameter.

Methods

(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

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.

toString() → {String}

String representation for debugging purpose.
Returns:
String representation

Type: String