JSDoc: Class: TransactionInfo

new TransactionInfo()

Source:

payments/TransactionInfo.js, line 22

Methods

(static) TransactionInfo#getAccountSelection() → {payments.AccountType}

Get the field value

Source:

payments/TransactionInfo.js, line 122

Returns:

Type: payments.AccountType

(static) TransactionInfo#getApplicationPanSequenceNumber() → {String}

Get the field value Identifies and differentiates cards with the same PAN.

Source:

payments/TransactionInfo.js, line 689

Returns:

Type: String

(static) TransactionInfo#getBatchNumber() → {String}

Get the field value Transaction Batch Number

Source:

payments/TransactionInfo.js, line 332

Returns:

Type: String

(static) TransactionInfo#getCardSymbol() → {String}

Get the field value Card Symbol for identify in payment_card_config table

Source:

payments/TransactionInfo.js, line 269

Returns:

Type: String

(static) TransactionInfo#getCardTypeLabel() → {String}

Get the field value Card type label

Source:

payments/TransactionInfo.js, line 248

Returns:

Type: String

(static) TransactionInfo#getClientCardType() → {payments.CardType}

Get the field value Client card type should be used only limited purpose only and should not be confused with cardType in other objects. This is a read only field and must not to be overwritten on server or client once set on client. This is set on client only for MSR tx for now as the AIDs are not identified for MSR. For few MSR tx, the card type was identified incorrectly on client side, and also on server side based on the bin match. In order to get the correct card types, this client card type will be sent to the server

Source:

payments/TransactionInfo.js, line 880

Returns:

Type: payments.CardType

(static) TransactionInfo#getECommTransactionInfo() → {payments.ECommTransactionInfo}

Get the field value

Source:

payments/TransactionInfo.js, line 851

Returns:

Type: payments.ECommTransactionInfo

(static) TransactionInfo#getEmergencyFlag() → {Boolean}

Get the field value Boolean value defining if the corresponding TX was performed in NEXO emergency mode according NEXO IS Spec chapter 10.2

Source:

payments/TransactionInfo.js, line 794

Returns:

Type: Boolean

(static) TransactionInfo#getEntryType() → {payments.CardEntryType}

Get the field value This field contains the entry type of a transaction.

Source:

payments/TransactionInfo.js, line 815

Returns:

Type: payments.CardEntryType

(static) TransactionInfo#getFiscalInvoiceNumber() → {String}

Get the field value Consists of 4 digits prefix + 8 digits

Source:

payments/TransactionInfo.js, line 143

Returns:

Type: String

(static) TransactionInfo#getIdentityDocument() → {customers.IdentityDocument|Null}

Get the field value Customers identification number and type

Source:

payments/TransactionInfo.js, line 311

Returns:

Type: customers.IdentityDocument | Null

(static) TransactionInfo#getInstallmentsPlanCode() → {String}

Get the field value AR Installments: plan alphanum code

Source:

payments/TransactionInfo.js, line 185

Returns:

Type: String

(static) TransactionInfo#getInstallmentsPlanDesc() → {String}

Get the field value AR Installments: selected plan desc

Source:

payments/TransactionInfo.js, line 227

Returns:

Type: String

(static) TransactionInfo#getInstallmentsPlanId() → {String}

Get the field value AR Installments: selected plan id

Source:

payments/TransactionInfo.js, line 206

Returns:

Type: String

(static) TransactionInfo#getInstallmentsQuantity() → {Number}

Get the field value AR Installments: number of installments

Source:

payments/TransactionInfo.js, line 164

Returns:

must be an integer

Type: Number

(static) TransactionInfo#getIsTokenBasedTx() → {Boolean}

Get the field value Boolean to determine if the transaction done using a vaulted card is a token based transaction

Source:

payments/TransactionInfo.js, line 731

Returns:

Type: Boolean

(static) TransactionInfo#getLanguageIndicator() → {String}

Get the field value 2 character language used for the transaction. Deprecated in factor of transactionLocale.

Source:

payments/TransactionInfo.js, line 83

Returns:

Type: String

(static) TransactionInfo#getMaskedTrack2() → {String}

Get the field value Masked track2 data

Source:

payments/TransactionInfo.js, line 521

Returns:

Type: String

(static) TransactionInfo#getMerchantIdentifier() → {String}

Get the field value When concatenated with the Acquirer Identifier, uniquely identifies a given merchant

Source:

payments/TransactionInfo.js, line 479

Returns:

Type: String

(static) TransactionInfo#getMerchantNameLocation() → {String}

Get the field value Indicates the name and location of the merchant

Source:

payments/TransactionInfo.js, line 500

Returns:

Type: String

(static) TransactionInfo#getOrigTransactionSequenceCounter() → {String}

Get the field value For reversal and capture transactions, this contains the reference (transactionSequenceCounter) to the originating transaction.

Source:

payments/TransactionInfo.js, line 752

Returns:

Type: String

(static) TransactionInfo#getPanMask() → {String}

Get the field value Contains the information how the PAN should masked.

Source:

payments/TransactionInfo.js, line 647

Returns:

Type: String

(static) TransactionInfo#getPromotionalMessage() → {payments.PromotionalMessage}

Get the field value

Source:

payments/TransactionInfo.js, line 833

Returns:

Type: payments.PromotionalMessage

(static) TransactionInfo#getReceiptExtraData() → {String}

Get the field value Extra data for receipt

Source:

payments/TransactionInfo.js, line 542

Returns:

Type: String

(static) TransactionInfo#getReceiptNumber() → {String}

Get the field value Transaction Receipt Number

Source:

payments/TransactionInfo.js, line 353

Returns:

Type: String

(static) TransactionInfo#getReversalMac() → {String}

Get the field value MAC for reversal

Source:

payments/TransactionInfo.js, line 416

Returns:

Type: String

(static) TransactionInfo#getReversalMacKsn() → {String}

Get the field value MAC KSN for reversal

Source:

payments/TransactionInfo.js, line 437

Returns:

Type: String

(static) TransactionInfo#getReversalReason() → {payments.ReversalReason}

Get the field value Contains the reason why the transaction should be reversed in the host. It has to be mapped in server with the expected value by the corresponding gateway

Source:

payments/TransactionInfo.js, line 710

Returns:

Type: payments.ReversalReason

(static) TransactionInfo#getReversalStan() → {Number}

Get the field value STAN for reversal

Source:

payments/TransactionInfo.js, line 395

Returns:

must be an integer

Type: Number

(static) TransactionInfo#getReversalStanRefNum() → {String}

Get the field value Reversal STAN Ref Num

Source:

payments/TransactionInfo.js, line 374

Returns:

Type: String

(static) TransactionInfo#getSelectedService() → {payments.SelectedService}

Get the field value Defines the Financial Service selected for the transaction

Source:

payments/TransactionInfo.js, line 563

Returns:

Type: payments.SelectedService

(static) TransactionInfo#getStan() → {Number}

Get the field value STAN(System Audit Trace Number)

Source:

payments/TransactionInfo.js, line 290

Returns:

must be an integer

Type: Number

(static) TransactionInfo#getTerminalIdentification() → {String}

Get the field value Designates the unique location of a terminal at a merchant

Source:

payments/TransactionInfo.js, line 458

Returns:

Type: String

(static) TransactionInfo#getTransactionLocale() → {String}

Get the field value Locale for the transaction (e.g. en-CA)

Source:

payments/TransactionInfo.js, line 104

Returns:

Type: String

(static) TransactionInfo#getTransactionResult() → {payments.TransactionResult}

Get the field value Result of the transaction

Source:

payments/TransactionInfo.js, line 584

Returns:

Type: payments.TransactionResult

(static) TransactionInfo#getTransactionSequenceCounter() → {String}

Get the field value Counter maintained by the terminal that is incremented for each transaction at the beginning of the Perform Service function.

Source:

payments/TransactionInfo.js, line 668

Returns:

Type: String

(static) TransactionInfo#getTransactionSequenceCounterUpdate() → {String}

Get the field value This field is populated when the TSC of a terminal is out of sync and is provided with an update.

Source:

payments/TransactionInfo.js, line 773

Returns:

Type: String

(static) TransactionInfo#getTransactionTags() → {String}

Get the field value Contains a hex string with needed TLV tags for certification

Source:

payments/TransactionInfo.js, line 605

Returns:

Type: String

(static) TransactionInfo#getTxFormat() → {payments.TxFormat}

Get the field value Contains the information how the data inside transactionTags should be coded - initially we cause default and nexo as formats

Source:

payments/TransactionInfo.js, line 626

Returns:

Type: payments.TxFormat

(static) TransactionInfo#setAccountSelection(accountSelection)

Set the field value

Parameters:

Name	Type	Description
`accountSelection`	payments.AccountType

Source:

payments/TransactionInfo.js, line 113

(static) TransactionInfo#setApplicationPanSequenceNumber(applicationPanSequenceNumber)

Set the field value Identifies and differentiates cards with the same PAN.

Parameters:

Name	Type	Description
`applicationPanSequenceNumber`	String

Source:

payments/TransactionInfo.js, line 679

(static) TransactionInfo#setBatchNumber(batchNumber)

Set the field value Transaction Batch Number

Parameters:

Name	Type	Description
`batchNumber`	String

Source:

payments/TransactionInfo.js, line 322

(static) TransactionInfo#setCardSymbol(cardSymbol)

Set the field value Card Symbol for identify in payment_card_config table

Parameters:

Name	Type	Description
`cardSymbol`	String

Source:

payments/TransactionInfo.js, line 259

(static) TransactionInfo#setCardTypeLabel(cardTypeLabel)

Set the field value Card type label

Parameters:

Name	Type	Description
`cardTypeLabel`	String

Source:

payments/TransactionInfo.js, line 238

(static) TransactionInfo#setClientCardType(clientCardType)

Set the field value Client card type should be used only limited purpose only and should not be confused with cardType in other objects. This is a read only field and must not to be overwritten on server or client once set on client. This is set on client only for MSR tx for now as the AIDs are not identified for MSR. For few MSR tx, the card type was identified incorrectly on client side, and also on server side based on the bin match. In order to get the correct card types, this client card type will be sent to the server

Parameters:

Name	Type	Description
`clientCardType`	payments.CardType

Source:

payments/TransactionInfo.js, line 866

(static) TransactionInfo#setECommTransactionInfo(eCommTransactionInfo)

Set the field value

Parameters:

Name	Type	Description
`eCommTransactionInfo`	payments.ECommTransactionInfo

Source:

payments/TransactionInfo.js, line 842

(static) TransactionInfo#setEmergencyFlag(emergencyFlag)

Set the field value Boolean value defining if the corresponding TX was performed in NEXO emergency mode according NEXO IS Spec chapter 10.2

Parameters:

Name	Type	Description
`emergencyFlag`	Boolean

Source:

payments/TransactionInfo.js, line 784

(static) TransactionInfo#setEntryType(entryType)

Set the field value This field contains the entry type of a transaction.

Parameters:

Name	Type	Description
`entryType`	payments.CardEntryType

Source:

payments/TransactionInfo.js, line 805

(static) TransactionInfo#setFiscalInvoiceNumber(fiscalInvoiceNumber)

Set the field value Consists of 4 digits prefix + 8 digits

Parameters:

Name	Type	Description
`fiscalInvoiceNumber`	String

Source:

payments/TransactionInfo.js, line 133

(static) TransactionInfo#setIdentityDocument(identityDocument)

Set the field value Customers identification number and type

Parameters:

Name	Type	Description
`identityDocument`	customers.IdentityDocument \| Null

Source:

payments/TransactionInfo.js, line 301

(static) TransactionInfo#setInstallmentsPlanCode(installmentsPlanCode)

Set the field value AR Installments: plan alphanum code

Parameters:

Name	Type	Description
`installmentsPlanCode`	String

Source:

payments/TransactionInfo.js, line 175

(static) TransactionInfo#setInstallmentsPlanDesc(installmentsPlanDesc)

Set the field value AR Installments: selected plan desc

Parameters:

Name	Type	Description
`installmentsPlanDesc`	String

Source:

payments/TransactionInfo.js, line 217

(static) TransactionInfo#setInstallmentsPlanId(installmentsPlanId)

Set the field value AR Installments: selected plan id

Parameters:

Name	Type	Description
`installmentsPlanId`	String

Source:

payments/TransactionInfo.js, line 196

(static) TransactionInfo#setInstallmentsQuantity(installmentsQuantity)

Set the field value AR Installments: number of installments

Parameters:

Name	Type	Description
`installmentsQuantity`	Number	must be an integer

Source:

payments/TransactionInfo.js, line 154

(static) TransactionInfo#setIsTokenBasedTx(isTokenBasedTx)

Set the field value Boolean to determine if the transaction done using a vaulted card is a token based transaction

Parameters:

Name	Type	Description
`isTokenBasedTx`	Boolean

Source:

payments/TransactionInfo.js, line 721

(static) TransactionInfo#setLanguageIndicator(languageIndicator)

Set the field value 2 character language used for the transaction. Deprecated in factor of transactionLocale.

Parameters:

Name	Type	Description
`languageIndicator`	String

Source:

payments/TransactionInfo.js, line 73

(static) TransactionInfo#setMaskedTrack2(maskedTrack2)

Set the field value Masked track2 data

Parameters:

Name	Type	Description
`maskedTrack2`	String

Source:

payments/TransactionInfo.js, line 511

(static) TransactionInfo#setMerchantIdentifier(merchantIdentifier)

Set the field value When concatenated with the Acquirer Identifier, uniquely identifies a given merchant

Parameters:

Name	Type	Description
`merchantIdentifier`	String

Source:

payments/TransactionInfo.js, line 469

(static) TransactionInfo#setMerchantNameLocation(merchantNameLocation)

Set the field value Indicates the name and location of the merchant

Parameters:

Name	Type	Description
`merchantNameLocation`	String

Source:

payments/TransactionInfo.js, line 490

(static) TransactionInfo#setOrigTransactionSequenceCounter(origTransactionSequenceCounter)

Set the field value For reversal and capture transactions, this contains the reference (transactionSequenceCounter) to the originating transaction.

Parameters:

Name	Type	Description
`origTransactionSequenceCounter`	String

Source:

payments/TransactionInfo.js, line 742

(static) TransactionInfo#setPanMask(panMask)

Set the field value Contains the information how the PAN should masked.

Parameters:

Name	Type	Description
`panMask`	String

Source:

payments/TransactionInfo.js, line 637

(static) TransactionInfo#setPromotionalMessage(promotionalMessage)

Set the field value

Parameters:

Name	Type	Description
`promotionalMessage`	payments.PromotionalMessage

Source:

payments/TransactionInfo.js, line 824

(static) TransactionInfo#setReceiptExtraData(receiptExtraData)

Set the field value Extra data for receipt

Parameters:

Name	Type	Description
`receiptExtraData`	String

Source:

payments/TransactionInfo.js, line 532

(static) TransactionInfo#setReceiptNumber(receiptNumber)

Set the field value Transaction Receipt Number

Parameters:

Name	Type	Description
`receiptNumber`	String

Source:

payments/TransactionInfo.js, line 343

(static) TransactionInfo#setReversalMac(reversalMac)

Set the field value MAC for reversal

Parameters:

Name	Type	Description
`reversalMac`	String

Source:

payments/TransactionInfo.js, line 406

(static) TransactionInfo#setReversalMacKsn(reversalMacKsn)

Set the field value MAC KSN for reversal

Parameters:

Name	Type	Description
`reversalMacKsn`	String

Source:

payments/TransactionInfo.js, line 427

(static) TransactionInfo#setReversalReason(reversalReason)

Set the field value Contains the reason why the transaction should be reversed in the host. It has to be mapped in server with the expected value by the corresponding gateway

Parameters:

Name	Type	Description
`reversalReason`	payments.ReversalReason

Source:

payments/TransactionInfo.js, line 700

(static) TransactionInfo#setReversalStan(reversalStan)

Set the field value STAN for reversal

Parameters:

Name	Type	Description
`reversalStan`	Number	must be an integer

Source:

payments/TransactionInfo.js, line 385

(static) TransactionInfo#setReversalStanRefNum(reversalStanRefNum)

Set the field value Reversal STAN Ref Num

Parameters:

Name	Type	Description
`reversalStanRefNum`	String

Source:

payments/TransactionInfo.js, line 364

(static) TransactionInfo#setSelectedService(selectedService)

Set the field value Defines the Financial Service selected for the transaction

Parameters:

Name	Type	Description
`selectedService`	payments.SelectedService

Source:

payments/TransactionInfo.js, line 553

(static) TransactionInfo#setStan(stan)

Set the field value STAN(System Audit Trace Number)

Parameters:

Name	Type	Description
`stan`	Number	must be an integer

Source:

payments/TransactionInfo.js, line 280

(static) TransactionInfo#setTerminalIdentification(terminalIdentification)

Set the field value Designates the unique location of a terminal at a merchant

Parameters:

Name	Type	Description
`terminalIdentification`	String

Source:

payments/TransactionInfo.js, line 448

(static) TransactionInfo#setTransactionLocale(transactionLocale)

Set the field value Locale for the transaction (e.g. en-CA)

Parameters:

Name	Type	Description
`transactionLocale`	String

Source:

payments/TransactionInfo.js, line 94

(static) TransactionInfo#setTransactionResult(transactionResult)

Set the field value Result of the transaction

Parameters:

Name	Type	Description
`transactionResult`	payments.TransactionResult

Source:

payments/TransactionInfo.js, line 574

(static) TransactionInfo#setTransactionSequenceCounter(transactionSequenceCounter)

Set the field value Counter maintained by the terminal that is incremented for each transaction at the beginning of the Perform Service function.

Parameters:

Name	Type	Description
`transactionSequenceCounter`	String

Source:

payments/TransactionInfo.js, line 658

(static) TransactionInfo#setTransactionSequenceCounterUpdate(transactionSequenceCounterUpdate)

Set the field value This field is populated when the TSC of a terminal is out of sync and is provided with an update.

Parameters:

Name	Type	Description
`transactionSequenceCounterUpdate`	String

Source:

payments/TransactionInfo.js, line 763

(static) TransactionInfo#setTransactionTags(transactionTags)

Set the field value Contains a hex string with needed TLV tags for certification

Parameters:

Name	Type	Description
`transactionTags`	String

Source:

payments/TransactionInfo.js, line 595

(static) TransactionInfo#setTxFormat(txFormat)

Set the field value Contains the information how the data inside transactionTags should be coded - initially we cause default and nexo as formats

Parameters:

Name	Type	Description
`txFormat`	payments.TxFormat

Source:

payments/TransactionInfo.js, line 616