Package com.six.timapi

Class TransactionInformation

java.lang.Object

com.six.timapi.TransactionInformation

public class TransactionInformation
extends Object

Contains information about a finished transaction after calling the Terminal.transaction(com.six.timapi.constants.TransactionType, com.six.timapi.Amount) or Terminal.transactionAsync(com.six.timapi.constants.TransactionType, com.six.timapi.Amount). Immutable class.

Constructor Summary

Constructors

Constructor

Description

TransactionInformation(PosEntryMode posEntryMode, Cvm cvm, MerchantAction merchantAction, String authCode, TimeDate timeStamp, Long transRef, Long transSeq, long acqId, SignatureInformation signatureInformation, String trmTransRef, String acqTransRef, String sixTrxRefNum, String cardholder, String clientIdentifier, String accountNumber, Long personOid, String cardId, Boolean ngvUsedFlag, String omnichannelPaymentId, String schemeTrxId, AgeCheckResult ageCheckResult)

Create transaction information.

Method Summary

Modifier and Type	Method	Description
String	getAccountNumber()	Account number of the card used.
long	getAcqId()	Acquirer identifier.
String	getAcqTransRef()	Transaction reference from the acquirer.
AgeCheckResult	getAgeCheckResult()	Result of age check.
String	getAuthCode()	Authorization code received from the acquirer.
String	getCardholderName()	Deprecated. use CardData.getCardholder()
String	getCardId()	Card ID.
String	getClientIdentifier()	Cardholder ID- or Passport number.
Cvm	getCvm()	Cardholder verification method.
MerchantAction	getMerchantAction()	Feedback to know which merchant action has to be performed.
Boolean	getNGVUsedFlag()	Indicates if a transaction was performed as non guaranteed payment (NGV).
String	getOmnichannelPaymentId()	Omnichannel payment / transaction identifier.
Long	getPersonOid()	Person OID.
PosEntryMode	getPosEntryMode()	According to EMV definition.
String	getSchemeTrxId()
SignatureInformation	getSignatureInformation()	Signature captured by EFT Terminal if present.
String	getSixTrxRefNum()	SIX Transaction Reference.
TimeDate	getTimeStamp()	Local time of the transaction.
Long	getTransRef()	Transaction reference defined by the terminal.
Long	getTransSeq()	Transaction sequence number defined by the terminal.
String	getTrmTransRef()	Transaction reference from the terminal.
String	toString()	String representation for debugging purpose.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TransactionInformation

public TransactionInformation(PosEntryMode posEntryMode,
                              Cvm cvm,
                              MerchantAction merchantAction,
                              String authCode,
                              TimeDate timeStamp,
                              Long transRef,
                              Long transSeq,
                              long acqId,
                              SignatureInformation signatureInformation,
                              String trmTransRef,
                              String acqTransRef,
                              String sixTrxRefNum,
                              String cardholder,
                              String clientIdentifier,
                              String accountNumber,
                              Long personOid,
                              String cardId,
                              Boolean ngvUsedFlag,
                              String omnichannelPaymentId,
                              String schemeTrxId,
                              AgeCheckResult ageCheckResult)

Create transaction information.

Method Detail

getPosEntryMode

public PosEntryMode getPosEntryMode()

According to EMV definition. Mandatory for:

• TransactionType.ACTIVATE_CARD
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COLLECT_POINTS
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.UNLOAD

Conditional for (can be null):

• TransactionType.ADJUST_RESERVATION
• TransactionType.FINALIZE_PURCHASE
• TransactionType.LOAD_VOUCHER
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.RESERVATION

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION
• TransactionType.CANCEL_RESERVATION
• TransactionType.REVERSAL

getCvm

public Cvm getCvm()

Cardholder verification method. Conditional for (can be null):

• TransactionType.ACTIVATE_CARD
• TransactionType.ADJUST_RESERVATION
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CANCEL_RESERVATION
• TransactionType.CASH_ADVANCE
• TransactionType.COLLECT_POINTS
• TransactionType.COMBINED
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD_VOUCHER
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.RESERVATION
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.CREDIT
• TransactionType.LOAD
• TransactionType.REFUNDING
• TransactionType.REVERSAL

getMerchantAction

public MerchantAction getMerchantAction()

Feedback to know which merchant action has to be performed. Mandatory for:

• TransactionType.ACTIVATE_CARD
• TransactionType.ADJUST_RESERVATION
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CANCEL_RESERVATION
• TransactionType.CASH_ADVANCE
• TransactionType.COLLECT_POINTS
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD_VOUCHER
• TransactionType.LOAD
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.RESERVATION
• TransactionType.REVERSAL
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION

getAuthCode

public String getAuthCode()

Authorization code received from the acquirer. Conditional for (can be null):

• TransactionType.ACTIVATE_CARD
• TransactionType.ADJUST_RESERVATION
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COLLECT_POINTS
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD_VOUCHER
• TransactionType.LOAD
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.RESERVATION
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION
• TransactionType.CANCEL_RESERVATION
• TransactionType.REVERSAL

getTimeStamp

public TimeDate getTimeStamp()

Local time of the transaction. Mandatory for:

• TransactionType.ACTIVATE_CARD
• TransactionType.ADJUST_RESERVATION
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CANCEL_RESERVATION
• TransactionType.CASH_ADVANCE
• TransactionType.COLLECT_POINTS
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD_VOUCHER
• TransactionType.LOAD
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.RESERVATION
• TransactionType.REVERSAL
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION

getTransRef

public Long getTransRef()

Transaction reference defined by the terminal. Conditional for (can be null):

• TransactionType.ACTIVATE_CARD
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.REVERSAL
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION
• TransactionType.ADJUST_RESERVATION
• TransactionType.CANCEL_RESERVATION
• TransactionType.COLLECT_POINTS
• TransactionType.LOAD_VOUCHER
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.RESERVATION

getTransSeq

public Long getTransSeq()

Transaction sequence number defined by the terminal. Conditional for (can be null):

• TransactionType.ACTIVATE_CARD
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.REVERSAL
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION
• TransactionType.ADJUST_RESERVATION
• TransactionType.CANCEL_RESERVATION
• TransactionType.COLLECT_POINTS
• TransactionType.LOAD_VOUCHER
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.RESERVATION

getAcqId

public long getAcqId()

Acquirer identifier. Conditional for (can be null):

• TransactionType.ACTIVATE_CARD
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.REVERSAL
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION
• TransactionType.ADJUST_RESERVATION
• TransactionType.CANCEL_RESERVATION
• TransactionType.COLLECT_POINTS
• TransactionType.LOAD_VOUCHER
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.RESERVATION

getSignatureInformation

public SignatureInformation getSignatureInformation()

Signature captured by EFT Terminal if present. Mandatory for:

• TransactionType.LOAD_VOUCHER

Conditional for (can be null):

• TransactionType.ACTIVATE_CARD
• TransactionType.ADJUST_RESERVATION
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CANCEL_RESERVATION
• TransactionType.CASH_ADVANCE
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.RESERVATION
• TransactionType.REVERSAL
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.COLLECT_POINTS

getTrmTransRef

public String getTrmTransRef()

Transaction reference from the terminal. Mandatory for:

• TransactionType.ADJUST_RESERVATION
• TransactionType.CANCEL_RESERVATION
• TransactionType.COLLECT_POINTS
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.RESERVATION

Conditional for (can be null):

• TransactionType.ACTIVATE_CARD
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD_VOUCHER
• TransactionType.LOAD
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.REVERSAL
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION

getAcqTransRef

public String getAcqTransRef()

Transaction reference from the acquirer. Mandatory for:

• TransactionType.ADJUST_RESERVATION
• TransactionType.CANCEL_RESERVATION
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.RESERVATION

Conditional for (can be null):

• TransactionType.ACTIVATE_CARD
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COLLECT_POINTS
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD_VOUCHER
• TransactionType.LOAD
• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_PHONE_ORDERED
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.PURCHASE
• TransactionType.REFUNDING
• TransactionType.UNLOAD

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION
• TransactionType.REVERSAL

getSixTrxRefNum

public String getSixTrxRefNum()

SIX Transaction Reference. This is guaranteed to be not null.

getCardholderName

public String getCardholderName()

Deprecated.

use CardData.getCardholder()

Cardholder name.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

getClientIdentifier

public String getClientIdentifier()

Cardholder ID- or Passport number.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

Conditional for (can be null):

• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.GIRO
• TransactionType.PURCHASE
• TransactionType.REVERSAL

Otherwise Forbidden (always null)

getAccountNumber

public String getAccountNumber()

Account number of the card used.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

Conditional for (can be null):

• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.GIRO
• TransactionType.PURCHASE
• TransactionType.REVERSAL

Otherwise Forbidden (always null)

getPersonOid

public Long getPersonOid()

Person OID.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

Conditional for (can be null):

• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CASH_ADVANCE
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.GIRO
• TransactionType.PURCHASE
• TransactionType.REVERSAL

Otherwise Forbidden (always null)

getCardId

public String getCardId()

Card ID.

Optional: Mandatory if requested by acquirer.

Specifications: banking, austrianUseCases.

getNGVUsedFlag

public Boolean getNGVUsedFlag()

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

getOmnichannelPaymentId

public String getOmnichannelPaymentId()

Omnichannel payment / transaction identifier.

Optional: Mandatory if available to terminal.

Specifications: retail, banking, austrianUseCases.

getSchemeTrxId

public String getSchemeTrxId()

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.

getAgeCheckResult

public AgeCheckResult getAgeCheckResult()

Result of age check.

Optional: Mandatory if available to terminal.

Specifications: valueAddedServices.

Conditional for (can be null):

• TransactionType.PRE_AUTHORIZATION
• TransactionType.PURCHASE
• TransactionType.PURCHASE_WITH_CASHBACK
• TransactionType.RESERVATION

Forbidden (always null):

• TransactionType.ACCOUNT_VERIFICATION
• TransactionType.ACTIVATE_CARD
• TransactionType.ADJUST_RESERVATION
• TransactionType.AUTHORIZE_CREDIT
• TransactionType.AUTHORIZE_DEPOSIT
• TransactionType.CANCEL_RESERVATION
• TransactionType.CASH_ADVANCE
• TransactionType.COLLECT_POINTS
• TransactionType.COMBINED
• TransactionType.CREDIT
• TransactionType.DEBT_RECOVERY
• TransactionType.FINALIZE_PURCHASE
• TransactionType.FUNDING
• TransactionType.GIRO
• TransactionType.LOAD
• TransactionType.LOAD_VOUCHER
• TransactionType.PURCHASE_FORCED_ACCEPTANCE
• TransactionType.PURCHASE_MAIL_ORDERED
• TransactionType.PURCHASE_PHONE_AUTHORIZED
• TransactionType.PURCHASE_RESERVATION
• TransactionType.PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType.REFUNDING
• TransactionType.REVERSAL
• TransactionType.UNLOAD

toString

public String toString()

String representation for debugging purpose.

Overrides:

toString in class Object