Class: TransactionInfo

payments.TransactionInfo()

new TransactionInfo()

Source:

Methods

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

Get the field value
Source:
Returns:
Type
payments.AccountType

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

Get the field value Identifies and differentiates cards with the same PAN.
Source:
Returns:
Type
String

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

Get the field value Transaction Batch Number
Source:
Returns:
Type
String

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

Get the field value Card Symbol for identify in payment_card_config table
Source:
Returns:
Type
String

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

Get the field value Card type label
Source:
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:
Returns:
Type
payments.CardType

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

Get the field value
Source:
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:
Returns:
Type
Boolean

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

Get the field value This field contains the entry type of a transaction.
Source:
Returns:
Type
payments.CardEntryType

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

Get the field value Consists of 4 digits prefix + 8 digits
Source:
Returns:
Type
String

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

Get the field value Customers identification number and type
Source:
Returns:
Type
customers.IdentityDocument | Null

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

Get the field value AR Installments: plan alphanum code
Source:
Returns:
Type
String

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

Get the field value AR Installments: selected plan desc
Source:
Returns:
Type
String

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

Get the field value AR Installments: selected plan id
Source:
Returns:
Type
String

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

Get the field value AR Installments: number of installments
Source:
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:
Returns:
Type
Boolean

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

Get the field value 2 character language used for the transaction. Deprecated in factor of transactionLocale.
Source:
Returns:
Type
String

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

Get the field value Masked track2 data
Source:
Returns:
Type
String

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

Get the field value When concatenated with the Acquirer Identifier, uniquely identifies a given merchant
Source:
Returns:
Type
String

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

Get the field value Indicates the name and location of the merchant
Source:
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:
Returns:
Type
String

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

Get the field value Contains the information how the PAN should masked.
Source:
Returns:
Type
String

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

Get the field value
Source:
Returns:
Type
payments.PromotionalMessage

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

Get the field value Extra data for receipt
Source:
Returns:
Type
String

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

Get the field value Transaction Receipt Number
Source:
Returns:
Type
String

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

Get the field value MAC for reversal
Source:
Returns:
Type
String

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

Get the field value MAC KSN for reversal
Source:
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:
Returns:
Type
payments.ReversalReason

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

Get the field value STAN for reversal
Source:
Returns:
must be an integer
Type
Number

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

Get the field value Reversal STAN Ref Num
Source:
Returns:
Type
String

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

Get the field value Defines the Financial Service selected for the transaction
Source:
Returns:
Type
payments.SelectedService

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

Get the field value STAN(System Audit Trace Number)
Source:
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:
Returns:
Type
String

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

Get the field value Locale for the transaction (e.g. en-CA)
Source:
Returns:
Type
String

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

Get the field value Result of the transaction
Source:
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:
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:
Returns:
Type
String

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

Get the field value Contains a hex string with needed TLV tags for certification
Source:
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:
Returns:
Type
payments.TxFormat

(static) TransactionInfo#setAccountSelection(accountSelection)

Set the field value
Parameters:
Name Type Description
accountSelection payments.AccountType
Source:

(static) TransactionInfo#setApplicationPanSequenceNumber(applicationPanSequenceNumber)

Set the field value Identifies and differentiates cards with the same PAN.
Parameters:
Name Type Description
applicationPanSequenceNumber String
Source:

(static) TransactionInfo#setBatchNumber(batchNumber)

Set the field value Transaction Batch Number
Parameters:
Name Type Description
batchNumber String
Source:

(static) TransactionInfo#setCardSymbol(cardSymbol)

Set the field value Card Symbol for identify in payment_card_config table
Parameters:
Name Type Description
cardSymbol String
Source:

(static) TransactionInfo#setCardTypeLabel(cardTypeLabel)

Set the field value Card type label
Parameters:
Name Type Description
cardTypeLabel String
Source:

(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:

(static) TransactionInfo#setECommTransactionInfo(eCommTransactionInfo)

Set the field value
Parameters:
Name Type Description
eCommTransactionInfo payments.ECommTransactionInfo
Source:

(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:

(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:

(static) TransactionInfo#setFiscalInvoiceNumber(fiscalInvoiceNumber)

Set the field value Consists of 4 digits prefix + 8 digits
Parameters:
Name Type Description
fiscalInvoiceNumber String
Source:

(static) TransactionInfo#setIdentityDocument(identityDocument)

Set the field value Customers identification number and type
Parameters:
Name Type Description
identityDocument customers.IdentityDocument | Null
Source:

(static) TransactionInfo#setInstallmentsPlanCode(installmentsPlanCode)

Set the field value AR Installments: plan alphanum code
Parameters:
Name Type Description
installmentsPlanCode String
Source:

(static) TransactionInfo#setInstallmentsPlanDesc(installmentsPlanDesc)

Set the field value AR Installments: selected plan desc
Parameters:
Name Type Description
installmentsPlanDesc String
Source:

(static) TransactionInfo#setInstallmentsPlanId(installmentsPlanId)

Set the field value AR Installments: selected plan id
Parameters:
Name Type Description
installmentsPlanId String
Source:

(static) TransactionInfo#setInstallmentsQuantity(installmentsQuantity)

Set the field value AR Installments: number of installments
Parameters:
Name Type Description
installmentsQuantity Number must be an integer
Source:

(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:

(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:

(static) TransactionInfo#setMaskedTrack2(maskedTrack2)

Set the field value Masked track2 data
Parameters:
Name Type Description
maskedTrack2 String
Source:

(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:

(static) TransactionInfo#setMerchantNameLocation(merchantNameLocation)

Set the field value Indicates the name and location of the merchant
Parameters:
Name Type Description
merchantNameLocation String
Source:

(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:

(static) TransactionInfo#setPanMask(panMask)

Set the field value Contains the information how the PAN should masked.
Parameters:
Name Type Description
panMask String
Source:

(static) TransactionInfo#setPromotionalMessage(promotionalMessage)

Set the field value
Parameters:
Name Type Description
promotionalMessage payments.PromotionalMessage
Source:

(static) TransactionInfo#setReceiptExtraData(receiptExtraData)

Set the field value Extra data for receipt
Parameters:
Name Type Description
receiptExtraData String
Source:

(static) TransactionInfo#setReceiptNumber(receiptNumber)

Set the field value Transaction Receipt Number
Parameters:
Name Type Description
receiptNumber String
Source:

(static) TransactionInfo#setReversalMac(reversalMac)

Set the field value MAC for reversal
Parameters:
Name Type Description
reversalMac String
Source:

(static) TransactionInfo#setReversalMacKsn(reversalMacKsn)

Set the field value MAC KSN for reversal
Parameters:
Name Type Description
reversalMacKsn String
Source:

(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:

(static) TransactionInfo#setReversalStan(reversalStan)

Set the field value STAN for reversal
Parameters:
Name Type Description
reversalStan Number must be an integer
Source:

(static) TransactionInfo#setReversalStanRefNum(reversalStanRefNum)

Set the field value Reversal STAN Ref Num
Parameters:
Name Type Description
reversalStanRefNum String
Source:

(static) TransactionInfo#setSelectedService(selectedService)

Set the field value Defines the Financial Service selected for the transaction
Parameters:
Name Type Description
selectedService payments.SelectedService
Source:

(static) TransactionInfo#setStan(stan)

Set the field value STAN(System Audit Trace Number)
Parameters:
Name Type Description
stan Number must be an integer
Source:

(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:

(static) TransactionInfo#setTransactionLocale(transactionLocale)

Set the field value Locale for the transaction (e.g. en-CA)
Parameters:
Name Type Description
transactionLocale String
Source:

(static) TransactionInfo#setTransactionResult(transactionResult)

Set the field value Result of the transaction
Parameters:
Name Type Description
transactionResult payments.TransactionResult
Source:

(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:

(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:

(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:

(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: