Package com.six.timapi

Class TransactionData

java.lang.Object

com.six.timapi.TransactionData

public class TransactionData
extends Object

Contains configuration for transaction used by Terminal.transaction(com.six.timapi.constants.TransactionType, com.six.timapi.Amount) or Terminal.transactionAsync(com.six.timapi.constants.TransactionType, com.six.timapi.Amount).

Constructor Summary

Constructors

Constructor	Description
TransactionData()	Create transaction data.
TransactionData(com.six.timapi.internal.TimSavedState savedState)	For internal use only.
TransactionData(TransactionData data)	Create copy of transaction data.

Method Summary

Modifier and Type	Method	Description
com.six.timapi.internal.TimSavedState	createSavedState()	For internal use only.
Long	getAcqId()	Acquirer identifier.
String	getAcqTransRef()	Transaction reference from the acquirer.
Long	getAgeToCheck()	Age to verify to allow transaction or null to disable age check.
EnumSet<AllowedAccounts>	getAllowedAccounts()	Allowed accounts or null.
TimeDate	getAppExpirationDate()
String	getAuthCode()
String	getCardRef()	Petrol: Reference from the card.
Long	getCvc2()
Boolean	getDccAllowed()	Allows the EFT Terminal to enable DCC function.
Boolean	getDeferredAuthInd()	Indicates that the transaction shall be performed using deffered authorisation.
Long	getEcrSeqCounter()	ECR sequence counter.
Boolean	getInstallmentAllowed()	Indicates if installment shall be allowed for a transaction.
String	getLanguage()	Petrol, Unattended: Language.
Boolean	getMultiCurrencyFlag()	Indicates if the transaction uses multiple currencies.
int	getNGVClearingDelay()	Defines the clearing delay of the PurchaseNGV transaction.
NgvMode	getNGVMode()	Defines if NGV usage is mandatory or optional if card supports it.
String	getOmnichannelMerchantId()	The OmnichannelMerchantId is used to identify the merchant on a Omnichannel host.
String	getOmnichannelPaymentId()	To identify an Omnichannel transaction (not used for Saferpay) the OmnichannelPaymentId has to be set in TransactionData.
Boolean	getPartialApprovalAllowed()	Partial approval is allowed.
String	getPhoneAuthCode()	Phone authorization code.
String	getSaferpayAlias()	Saferpay alias.
boolean	getSaferpayRecurring()	Saferpay recurring enabled.
String	getSixTrxRefNum()	SIX Transaction Reference Number.
List<SubTransaction>	getSubTransactions()	Sub transactions.
Boolean	getTipAllowed()	Tip is allowed for purchase transactions.
String	getTokenPan()	The token PAN is a tokenized version for an underlaying card PAN.
TokenPanType	getTokenPanType()	To differ the source of a token PAN, the TokenPanType field is used in a SIXml request message as part of the sixml:TransactionData container and in a SIXml response message as part of the sixml:CardData container.
TransactionReason	getTransactionReason()	Set the transaction reason to setup credential on file.
Long	getTransRef()	Transaction reference defined by the terminal.
Long	getTransSeq()	Transaction sequence number defined by the terminal.
String	getTrmTransRef()	Transaction reference from the terminal.
TimeDate	getTrxOriginalDate()	Timestamp of the original transaction.
void	setAcqId(Long acqId)	Set acquirer identifier.
void	setAcqTransRef(long acqId, int trxRefNo)	Set transaction reference from the acquirer.
void	setAcqTransRef(String acqTransRef)	Set transaction reference from the acquirer.
void	setAgeToCheck(Long ageToCheck)	Set age to verify to allow transaction or null to disable age check.
void	setAllowedAccounts(EnumSet<AllowedAccounts> allowedAccounts)	Allowed accounts or null.
void	setAppExpirationDate(TimeDate appExpirationDate)
void	setAuthCode(String authCode)	If the underlying payment protocol supports/requests it, for referencing a previous transaction that shall be refunded.
void	setCardRef(String cardRef)	Petrol: Set reference from the card.
void	setCvc2(Long cvc2)
void	setDccAllowed(Boolean dccAllowed)	Set allows the EFT Terminal to enable DCC function.
void	setDeferredAuthInd(Boolean deferredAuthInd)	Indicates that the transaction shall be performed using deffered authorisation.
void	setEcrSeqCounter(Long ecrSeqCounter)	Set ECR sequence counter.
void	setInstallmentAllowed(Boolean installmentAllowed)	Indicates if installment shall be allowed for a transaction.
void	setLanguage(String language)	Petrol, Unattended: Set language.
void	setMultiCurrencyFlag(Boolean flag)	Indicates if the transaction uses multiple currencies.
void	setNGVClearingDelay(int ngvClearingDelay)	Defines the clearing delay of the PurchaseNGV transaction.
void	setNGVMode(NgvMode ngvMode)	Defines if NGV usage is mandatory or optional if card supports it.
void	setOmnichannelMerchantId(String omnichannelMerchantId)	The OmnichannelMerchantId is used to identify the merchant on a Omnichannel host.
void	setOmnichannelPaymentId(String omnichannelPaymentId)	To identify an Omnichannel transaction (not used for Saferpay) the OmnichannelPaymentId has to be set in TransactionData.
void	setPartialApprovalAllowed(Boolean partialApprovalAllowed)	Set partial approval is allowed.
void	setPhoneAuthCode(String phoneAuthCode)	Set phone authorization code.
void	setSaferpayAlias(String alias)	Set saferpay alias.
void	setSaferpayRecurring(boolean saferpayRecurring)	Set saferpay recurring enabled.
void	setSixTrxRefNum(long acqId, String trxRefNum)	SIX Transaction Reference Number for integrators using MPD Client.
void	setSixTrxRefNum(String sixTrxRefNum)	SIX Transaction Reference Number.
void	setSubTransactions(List<SubTransaction> subTransactions)	Sub transactions.
void	setTipAllowed(Boolean tipAllowed)	Set if tip is allowed for purchase transactions.
void	setTokenPan(String tokenPan)	The token PAN is a tokenized version for an underlaying card PAN.
void	setTokenPanType(TokenPanType tokenPanType)	To differ the source of a token PAN, the TokenPanType field is used in a SIXml request message as part of the sixml:TransactionData container and in a SIXml response message as part of the sixml:CardData container.
void	setTransactionReason(TransactionReason transactionReason)	Set the transaction reason to setup credential on file.
void	setTransRef(Long transRef)	Set transaction reference defined by the terminal.
void	setTransSeq(Long transSeq)	Set transaction sequence number defined by the terminal.
void	setTrmTransRef(String trmTransRef)	Set transaction reference from the terminal.
void	setTrxOriginalDate(TimeDate trxOriginalDate)	Set timestamp of the original transaction.
String	toString()	String representation for debugging purpose.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionData

public TransactionData()

Create transaction data.

TransactionData

public TransactionData(TransactionData data)

Create copy of transaction data.

TransactionData

public TransactionData(com.six.timapi.internal.TimSavedState savedState)

For internal use only.

Method Detail

getDccAllowed

public Boolean getDccAllowed()

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

setDccAllowed

public void setDccAllowed(Boolean dccAllowed)

Set allows the EFT Terminal to enable DCC function. Use null to not use this parameter. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#ADJUST_RESERVATION
• TransactionType#CASH_ADVANCE
• TransactionType#DEBT_RECOVERY
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#RESERVATION

Forbidden (has to be always null):

• TransactionType#ACTIVATE_CARD
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#CANCEL_RESERVATION
• TransactionType#COLLECT_POINTS
• TransactionType#COMBINED
• TransactionType#CREDIT
• TransactionType#FINALIZE_PURCHASE
• TransactionType#FUNDING
• TransactionType#GIRO
• TransactionType#INIT_TRANSACTION
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PURCHASE
• TransactionType#REFUNDING
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Transactions will fail if one of the above mentioned restrictions are violated.

getTrxOriginalDate

public TimeDate getTrxOriginalDate()

Timestamp of the original transaction.

setTrxOriginalDate

public void setTrxOriginalDate(TimeDate trxOriginalDate)

Set timestamp of the original transaction. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#CREDIT
• TransactionType#LOAD
• TransactionType#REFUNDING

Forbidden (has to be always 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#INIT_TRANSACTION
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Transactions will fail if one of the above mentioned restrictions are violated.

getEcrSeqCounter

public Long getEcrSeqCounter()

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

setEcrSeqCounter

public void setEcrSeqCounter(Long ecrSeqCounter)

Set ECR sequence counter. Use null to not use this parameter. Mandatory for (can not be null):

Conditional for (can be 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#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#INIT_TRANSACTION

Transactions will fail if one of the above mentioned restrictions are violated.

getPartialApprovalAllowed

public Boolean getPartialApprovalAllowed()

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

setPartialApprovalAllowed

public void setPartialApprovalAllowed(Boolean partialApprovalAllowed)

Set partial approval is allowed. Use null to not use this parameter. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#ADJUST_RESERVATION
• TransactionType#CASH_ADVANCE
• TransactionType#COMBINED
• TransactionType#DEBT_RECOVERY
• TransactionType#GIRO
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#RESERVATION

Forbidden (has to be always null):

• TransactionType#ACTIVATE_CARD
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#CANCEL_RESERVATION
• TransactionType#COLLECT_POINTS
• TransactionType#CREDIT
• TransactionType#FINALIZE_PURCHASE
• TransactionType#FUNDING
• TransactionType#INIT_TRANSACTION
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#REFUNDING
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Transactions will fail if one of the above mentioned restrictions are violated.

getTransRef

public Long getTransRef()

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

setTransRef

public void setTransRef(Long transRef)

Set transaction reference defined by the terminal. Use null to not use this parameter. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#CREDIT
• TransactionType#FINALIZE_PURCHASE
• TransactionType#LOAD
• TransactionType#REFUNDING

Forbidden (has to be always null):

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

Transactions will fail if one of the above mentioned restrictions are violated.

getTransSeq

public Long getTransSeq()

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

setTransSeq

public void setTransSeq(Long transSeq)

Set transaction sequence number defined by the terminal. Use null to not use this parameter. Mandatory for (can not be null):

• TransactionType#REVERSAL

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#FINALIZE_PURCHASE

Forbidden (has to be always null):

• 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#FUNDING
• TransactionType#GIRO
• TransactionType#INIT_TRANSACTION
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#UNLOAD

Transactions will fail if one of the above mentioned restrictions are violated.

getCardRef

public String getCardRef()

Petrol: Reference from the card.

setCardRef

public void setCardRef(String cardRef)

Petrol: Set reference from the card. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• 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
• TransactionType#LOAD_VOUCHER
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#CANCEL_RESERVATION
• TransactionType#PRE_AUTHORIZATION

Transactions will fail if one of the above mentioned restrictions are violated.

getAcqId

public Long getAcqId()

Acquirer identifier. Uniquely identifies the acquirer.

setAcqId

public void setAcqId(Long acqId)

Set acquirer identifier. Uniquely identifies the acquirer. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#ADJUST_RESERVATION
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#CANCEL_RESERVATION
• TransactionType#CASH_ADVANCE
• TransactionType#COMBINED
• TransactionType#CREDIT
• TransactionType#DEBT_RECOVERY
• TransactionType#FINALIZE_PURCHASE
• TransactionType#GIRO
• TransactionType#LOAD
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL

Forbidden (has to be always null):

• TransactionType#ACTIVATE_CARD
• TransactionType#COLLECT_POINTS
• TransactionType#FUNDING
• TransactionType#INIT_TRANSACTION
• TransactionType#LOAD_VOUCHER
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#UNLOAD

Transactions will fail if one of the above mentioned restrictions are violated.

getAcqTransRef

public String getAcqTransRef()

Transaction reference from the acquirer.

setAcqTransRef

public void setAcqTransRef(String acqTransRef)

Set transaction reference from the acquirer. Mandatory for (can not be null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#CANCEL_RESERVATION
• TransactionType#DEBT_RECOVERY
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#REFUNDING
• TransactionType#UNLOAD

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#ACTIVATE_CARD
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#CASH_ADVANCE
• TransactionType#COLLECT_POINTS
• TransactionType#COMBINED
• TransactionType#CREDIT
• TransactionType#FINALIZE_PURCHASE
• TransactionType#FUNDING
• TransactionType#GIRO
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#RESERVATION
• TransactionType#REVERSAL

Forbidden (has to be always null):

• TransactionType#INIT_TRANSACTION

Transactions will fail if one of the above mentioned restrictions are violated.

setAcqTransRef

public void setAcqTransRef(long acqId,
                           int trxRefNo)

Set transaction reference from the acquirer. This method is to be used only for manual entry by clerks for EP2 hospitality transactions only. Mandatory for (can not be null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#CANCEL_RESERVATION
• TransactionType#DEBT_RECOVERY
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#REFUNDING
• TransactionType#UNLOAD

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#ACTIVATE_CARD
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#CASH_ADVANCE
• TransactionType#COLLECT_POINTS
• TransactionType#COMBINED
• TransactionType#CREDIT
• TransactionType#FINALIZE_PURCHASE
• TransactionType#FUNDING
• TransactionType#GIRO
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#RESERVATION
• TransactionType#REVERSAL

Forbidden (has to be always null):

• TransactionType#INIT_TRANSACTION

Transactions will fail if one of the above mentioned restrictions are violated.

Parameters:

acqId - Acquirer ID as printed on receipt.

trxRefNo - Transaction reference as printed on receipt.

getTrmTransRef

public String getTrmTransRef()

Transaction reference from the terminal.

setTrmTransRef

public void setTrmTransRef(String trmTransRef)

Set transaction reference from the terminal. Mandatory for (can not be null):

• TransactionType#FINALIZE_PURCHASE

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• 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#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#CANCEL_RESERVATION
• TransactionType#INIT_TRANSACTION
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED

Transactions will fail if one of the above mentioned restrictions are violated.

getTipAllowed

public Boolean getTipAllowed()

Tip is allowed for purchase transactions. Use null to not use this parameter. This parameter is only used if Guides.GASTRO is enabled.

setTipAllowed

public void setTipAllowed(Boolean tipAllowed)

Set if tip is allowed for purchase transactions. Use null to not use this parameter. This parameter is only used if Guides.GASTRO is enabled. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• 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
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#CANCEL_RESERVATION
• TransactionType#RESERVATION

Transactions will fail if one of the above mentioned restrictions are violated.

getPhoneAuthCode

public String getPhoneAuthCode()

Phone authorization code.

setPhoneAuthCode

public void setPhoneAuthCode(String phoneAuthCode)

Set phone authorization code. Mandatory for (can not be null):

• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#ACTIVATE_CARD
• TransactionType#COLLECT_POINTS
• TransactionType#DEBT_RECOVERY
• TransactionType#FINALIZE_PURCHASE
• TransactionType#FUNDING
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#REFUNDING
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#CANCEL_RESERVATION
• TransactionType#CASH_ADVANCE
• TransactionType#COMBINED
• TransactionType#CREDIT
• TransactionType#GIRO
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#RESERVATION

Transactions will fail if one of the above mentioned restrictions are violated.

getLanguage

public String getLanguage()

Petrol, Unattended: Language.

setLanguage

public void setLanguage(String language)

Petrol, Unattended: Set language. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACTIVATE_CARD
• TransactionType#ADJUST_RESERVATION
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#BALANCE_INQUIRY
• TransactionType#CANCEL_RESERVATION
• TransactionType#CASH_ADVANCE
• TransactionType#CLIENT_IDENTIFICATION
• TransactionType#COLLECT_POINTS
• TransactionType#COMBINED
• TransactionType#CREDIT
• TransactionType#DEBT_RECOVERY
• TransactionType#FUNDING
• TransactionType#GIRO
• TransactionType#INIT_TRANSACTION
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#SEND_CARD_COMMAND
• TransactionType#START_CHECKOUT
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#FINALIZE_PURCHASE
• TransactionType#REVERSAL

Transactions will fail if one of the above mentioned restrictions are violated.

getMultiCurrencyFlag

public Boolean getMultiCurrencyFlag()

Indicates if the transaction uses multiple currencies.

Optional: Indicates that the transaction uses multiple currencies.

Specifications: banking, gastro, hospitality, austrianUseCases.

setMultiCurrencyFlag

public void setMultiCurrencyFlag(Boolean flag)

Indicates if the transaction uses multiple currencies.

Optional: Indicates that the transaction uses multiple currencies.

Specifications: banking, gastro, hospitality, austrianUseCases.

Mandatory for (can not be null):

Conditional for (can be 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#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

Transactions will fail if one of the above mentioned restrictions are violated.

getNGVMode

public NgvMode getNGVMode()

Defines if NGV usage is mandatory or optional if card supports it. Available if Guides.AUSTRIAN_USE_CASES is enabled.

setNGVMode

public void setNGVMode(NgvMode ngvMode)

Defines if NGV usage is mandatory or optional if card supports it. Set to null if not used. Available if Guides.AUSTRIAN_USE_CASES is enabled. Mandatory for (can not be null):

Conditional for (can be 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#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

Transactions will fail if one of the above mentioned restrictions are violated.

getNGVClearingDelay

public int getNGVClearingDelay()

Defines the clearing delay of the PurchaseNGV transaction. Available if Guides.AUSTRIAN_USE_CASES is enabled.

setNGVClearingDelay

public void setNGVClearingDelay(int ngvClearingDelay)

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 getNgvMode() is null. Available if Guides.AUSTRIAN_USE_CASES is enabled. Mandatory for (can not be null):

Conditional for (can be 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#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

Transactions will fail if one of the above mentioned restrictions are violated.

getSixTrxRefNum

public String getSixTrxRefNum()

SIX Transaction Reference Number.

setSixTrxRefNum

public void setSixTrxRefNum(String sixTrxRefNum)

SIX Transaction Reference Number.

setSixTrxRefNum

public void setSixTrxRefNum(long acqId,
                            String trxRefNum)

SIX Transaction Reference Number for integrators using MPD Client.

getSaferpayAlias

public String getSaferpayAlias()

Saferpay alias.

setSaferpayAlias

public void setSaferpayAlias(String alias)

Set saferpay alias.

getSaferpayRecurring

public boolean getSaferpayRecurring()

Saferpay recurring enabled.

setSaferpayRecurring

public void setSaferpayRecurring(boolean saferpayRecurring)

Set saferpay recurring enabled.

getCvc2

public Long getCvc2()

Card verification code 2.

The card verification code 2 is used for transactions with MPKE as an additional security element that has to be provided.

It has an n3 value: Numeric 3 digits: 012

Optional: Used for MPKE for non-PCI brands.

Specifications: retail, advancedRetail, banking, gastro, hospitality, austrianUseCases.

setCvc2

public void setCvc2(Long cvc2)

Card verification code 2.

The card verification code 2 is used for transactions with MPKE as an additional security element that has to be provided.

It has an n3 value: Numeric 3 digits: 012

Optional: Used for MPKE for non-PCI brands.

Specifications: retail, advancedRetail, banking, gastro, hospitality, austrianUseCases.

Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• 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
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#CANCEL_RESERVATION
• TransactionType#INIT_TRANSACTION
• TransactionType#PURCHASE_RESERVATION

Transactions will fail if one of the above mentioned restrictions are violated.

getAppExpirationDate

public TimeDate getAppExpirationDate()

Application expiration date.

Each application on a card has a corresponding expiration date and can be read from the card.

Example: The format of an 'Expiration Date' is defined as MMyy, 2 digits for the month and 2 digits for the year. So January 2018 will have the following format as 'Expiration Date': 0118

Optional: Used for MPKE for non-PCI brands based transactions.

Specifications: retail, advancedRetail, banking, gastro, hospitality, austrianUseCases.

setAppExpirationDate

public void setAppExpirationDate(TimeDate appExpirationDate)

Application expiration date.

Each application on a card has a corresponding expiration date and can be read from the card.

Example: The format of an 'Expiration Date' is defined as MMyy, 2 digits for the month and 2 digits for the year. So January 2018 will have the following format as 'Expiration Date': 0118

Optional: Used for MPKE for non-PCI brands based transactions.

Specifications: retail, advancedRetail, banking, gastro, hospitality, austrianUseCases.

Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• 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
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#CANCEL_RESERVATION
• TransactionType#PURCHASE_RESERVATION

Transactions will fail if one of the above mentioned restrictions are violated.

getInstallmentAllowed

public Boolean getInstallmentAllowed()

Indicates if installment shall be allowed for a transaction. This tag can be set for each transaction separately to specifically allow or disallow installment feature during the corresponding transaction. As this is a boolean value is can be understood as follows: true: Installment is allowed for the transaction false: Installment is NOT allowed for the transaction

setInstallmentAllowed

public void setInstallmentAllowed(Boolean installmentAllowed)

Indicates if installment shall be allowed for a transaction. This tag can be set for each transaction separately to specifically allow or disallow installment feature during the corresponding transaction. As this is a boolean value is can be understood as follows: true: Installment is allowed for the transaction false: Installment is NOT allowed for the transaction Mandatory for (can not be null):

Conditional for (can be 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#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#INIT_TRANSACTION

Transactions will fail if one of the above mentioned restrictions are violated.

getDeferredAuthInd

public Boolean getDeferredAuthInd()

Indicates that the transaction shall be performed using deffered authorisation. The following values are valid: true: Deferred authorisation applies false: Standard authorisation scheme (default)

setDeferredAuthInd

public void setDeferredAuthInd(Boolean deferredAuthInd)

Indicates that the transaction shall be performed using deffered authorisation. The following values are valid: true: Deferred authorisation applies false: Standard authorisation scheme (default) Mandatory for (can not be null):

Conditional for (can be 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#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

Transactions will fail if one of the above mentioned restrictions are violated.

getTransactionReason

public TransactionReason getTransactionReason()

Set the transaction reason to setup credential on file.

setTransactionReason

public void setTransactionReason(TransactionReason transactionReason)

Set the transaction reason to setup credential on file. Mandatory for (can not be null):

Conditional for (can be 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#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#INIT_TRANSACTION

Transactions will fail if one of the above mentioned restrictions are violated.

getSubTransactions

public List<SubTransaction> getSubTransactions()

Sub transactions.

setSubTransactions

public void setSubTransactions(List<SubTransaction> subTransactions)

Sub transactions. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#COMBINED

Forbidden (has to be 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#CREDIT
• TransactionType#DEBT_RECOVERY
• TransactionType#FINALIZE_PURCHASE
• TransactionType#FUNDING
• TransactionType#GIRO
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Transactions will fail if one of the above mentioned restrictions are violated.

getAllowedAccounts

public EnumSet<AllowedAccounts> getAllowedAccounts()

Allowed accounts or null.

setAllowedAccounts

public void setAllowedAccounts(EnumSet<AllowedAccounts> allowedAccounts)

Allowed accounts or null. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#CREDIT
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_WITH_CASHBACK

Forbidden (has to be always null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#ACTIVATE_CARD
• TransactionType#ADJUST_RESERVATION
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#BALANCE_INQUIRY
• TransactionType#CANCEL_RESERVATION
• TransactionType#CASH_ADVANCE
• TransactionType#COLLECT_POINTS
• TransactionType#COMBINED
• TransactionType#DEBT_RECOVERY
• TransactionType#FINALIZE_PURCHASE
• TransactionType#FUNDING
• TransactionType#GIRO
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#REVERSAL
• TransactionType#UNLOAD

Transactions will fail if one of the above mentioned restrictions are violated.

getTokenPan

public String getTokenPan()

The token PAN is a tokenized version for an underlaying card PAN. If the underlaying payment protocol supports it, a payment transaction can be initiated with the token PAN instead of using a card. A token PAN is normally generated by a tokenization service either form the acquirer host or the issuer host. The TokenPan field is used in a SIXml request message as part of the sixml:TransactionData container to trigger a token-based transaction and in a SIXml response message as part of the sixml:CardData container for returning token PANs to the ECR. The TokenPan field always must be accompanied by a corresponding TokenPanType field.

setTokenPan

public void setTokenPan(String tokenPan)

The token PAN is a tokenized version for an underlaying card PAN. If the underlaying payment protocol supports it, a payment transaction can be initiated with the token PAN instead of using a card. A token PAN is normally generated by a tokenization service either form the acquirer host or the issuer host. The TokenPan field is used in a SIXml request message as part of the sixml:TransactionData container to trigger a token-based transaction and in a SIXml response message as part of the sixml:CardData container for returning token PANs to the ECR. The TokenPan field always must be accompanied by a corresponding TokenPanType field. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#ACTIVATE_CARD
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#CASH_ADVANCE
• TransactionType#COLLECT_POINTS
• TransactionType#COMBINED
• TransactionType#CREDIT
• TransactionType#FUNDING
• TransactionType#GIRO
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#CANCEL_RESERVATION
• TransactionType#DEBT_RECOVERY
• TransactionType#FINALIZE_PURCHASE
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#REVERSAL

Transactions will fail if one of the above mentioned restrictions are violated.

getTokenPanType

public TokenPanType getTokenPanType()

To differ the source of a token PAN, the TokenPanType field is used in a SIXml request message as part of the sixml:TransactionData container and in a SIXml response message as part of the sixml:CardData container. The TokenPanType field always is transmitted if a TokenPan field is transmitted but must not be transmitted alone.

setTokenPanType

public void setTokenPanType(TokenPanType tokenPanType)

To differ the source of a token PAN, the TokenPanType field is used in a SIXml request message as part of the sixml:TransactionData container and in a SIXml response message as part of the sixml:CardData container. The TokenPanType field always is transmitted if a TokenPan field is transmitted but must not be transmitted alone. Mandatory for (can not be null):

Conditional for (can be null):

• TransactionType#ACCOUNT_VERIFICATION
• TransactionType#ACTIVATE_CARD
• TransactionType#AUTHORIZE_CREDIT
• TransactionType#AUTHORIZE_DEPOSIT
• TransactionType#CASH_ADVANCE
• TransactionType#COLLECT_POINTS
• TransactionType#COMBINED
• TransactionType#CREDIT
• TransactionType#FUNDING
• TransactionType#GIRO
• TransactionType#LOAD
• TransactionType#LOAD_VOUCHER
• TransactionType#PRE_AUTHORIZATION
• TransactionType#PURCHASE
• TransactionType#PURCHASE_FORCED_ACCEPTANCE
• TransactionType#PURCHASE_MAIL_ORDERED
• TransactionType#PURCHASE_PHONE_ORDERED
• TransactionType#PURCHASE_WITH_CASHBACK
• TransactionType#REFUNDING
• TransactionType#RESERVATION
• TransactionType#UNLOAD

Forbidden (has to be always null):

• TransactionType#ADJUST_RESERVATION
• TransactionType#CANCEL_RESERVATION
• TransactionType#DEBT_RECOVERY
• TransactionType#FINALIZE_PURCHASE
• TransactionType#PURCHASE_PHONE_AUTHORIZED
• TransactionType#PURCHASE_RESERVATION
• TransactionType#PURCHASE_RESERVATION_PHONE_AUTHORIZED
• TransactionType#REVERSAL

Transactions will fail if one of the above mentioned restrictions are violated.

getOmnichannelPaymentId

public String getOmnichannelPaymentId()

To identify an Omnichannel transaction (not used for Saferpay) the OmnichannelPaymentId has to be set in TransactionData. This attribute is also used to identify the Omnichannel host, a OmnichannelPaymentId starting by '90' meens for example that Ogone has to be used. Mandatory for (can not be null):

Conditional for (can be null):

• SIX.TimApi.Constants.TransactionType.Credit

Forbidden (has to be always null):

• SIX.TimApi.Constants.TransactionType.AdjustReservation
• SIX.TimApi.Constants.TransactionType.CancelReservation
• SIX.TimApi.Constants.TransactionType.DebtRecovery
• SIX.TimApi.Constants.TransactionType.FinalizePurchase
• SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
• SIX.TimApi.Constants.TransactionType.PurchaseReservation
• SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
• SIX.TimApi.Constants.TransactionType.Reversal
• SIX.TimApi.Constants.TransactionType.AccountVerification
• SIX.TimApi.Constants.TransactionType.ActivateCard
• SIX.TimApi.Constants.TransactionType.AuthorizeCredit
• SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
• SIX.TimApi.Constants.TransactionType.CashAdvance
• SIX.TimApi.Constants.TransactionType.CollectPoints
• SIX.TimApi.Constants.TransactionType.Combined
• SIX.TimApi.Constants.TransactionType.Credit
• SIX.TimApi.Constants.TransactionType.Funding
• SIX.TimApi.Constants.TransactionType.Giro
• SIX.TimApi.Constants.TransactionType.Load
• SIX.TimApi.Constants.TransactionType.LoadVoucher
• SIX.TimApi.Constants.TransactionType.PreAuthorization
• SIX.TimApi.Constants.TransactionType.Purchase
• SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
• SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
• SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
• SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
• SIX.TimApi.Constants.TransactionType.Refunding
• SIX.TimApi.Constants.TransactionType.Reservation
• SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

setOmnichannelPaymentId

public void setOmnichannelPaymentId(String omnichannelPaymentId)

To identify an Omnichannel transaction (not used for Saferpay) the OmnichannelPaymentId has to be set in TransactionData. This attribute is also used to identify the Omnichannel host, a OmnichannelPaymentId starting by '90' meens for example that Ogone has to be used. Mandatory for (can not be null):

Conditional for (can be null):

• SIX.TimApi.Constants.TransactionType.Credit

Forbidden (has to be always null):

• SIX.TimApi.Constants.TransactionType.AdjustReservation
• SIX.TimApi.Constants.TransactionType.CancelReservation
• SIX.TimApi.Constants.TransactionType.DebtRecovery
• SIX.TimApi.Constants.TransactionType.FinalizePurchase
• SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
• SIX.TimApi.Constants.TransactionType.PurchaseReservation
• SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
• SIX.TimApi.Constants.TransactionType.Reversal
• SIX.TimApi.Constants.TransactionType.AccountVerification
• SIX.TimApi.Constants.TransactionType.ActivateCard
• SIX.TimApi.Constants.TransactionType.AuthorizeCredit
• SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
• SIX.TimApi.Constants.TransactionType.CashAdvance
• SIX.TimApi.Constants.TransactionType.CollectPoints
• SIX.TimApi.Constants.TransactionType.Combined
• SIX.TimApi.Constants.TransactionType.Credit
• SIX.TimApi.Constants.TransactionType.Funding
• SIX.TimApi.Constants.TransactionType.Giro
• SIX.TimApi.Constants.TransactionType.Load
• SIX.TimApi.Constants.TransactionType.LoadVoucher
• SIX.TimApi.Constants.TransactionType.PreAuthorization
• SIX.TimApi.Constants.TransactionType.Purchase
• SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
• SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
• SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
• SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
• SIX.TimApi.Constants.TransactionType.Refunding
• SIX.TimApi.Constants.TransactionType.Reservation
• SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

getOmnichannelMerchantId

public String getOmnichannelMerchantId()

The OmnichannelMerchantId is used to identify the merchant on a Omnichannel host. This field is not used for Saferpay, but is for example for Ogone. Mandatory for (can not be null):

Conditional for (can be null):

• SIX.TimApi.Constants.TransactionType.Credit

Forbidden (has to be always null):

• SIX.TimApi.Constants.TransactionType.AdjustReservation
• SIX.TimApi.Constants.TransactionType.CancelReservation
• SIX.TimApi.Constants.TransactionType.DebtRecovery
• SIX.TimApi.Constants.TransactionType.FinalizePurchase
• SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
• SIX.TimApi.Constants.TransactionType.PurchaseReservation
• SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
• SIX.TimApi.Constants.TransactionType.Reversal
• SIX.TimApi.Constants.TransactionType.AccountVerification
• SIX.TimApi.Constants.TransactionType.ActivateCard
• SIX.TimApi.Constants.TransactionType.AuthorizeCredit
• SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
• SIX.TimApi.Constants.TransactionType.CashAdvance
• SIX.TimApi.Constants.TransactionType.CollectPoints
• SIX.TimApi.Constants.TransactionType.Combined
• SIX.TimApi.Constants.TransactionType.Funding
• SIX.TimApi.Constants.TransactionType.Giro
• SIX.TimApi.Constants.TransactionType.Load
• SIX.TimApi.Constants.TransactionType.LoadVoucher
• SIX.TimApi.Constants.TransactionType.PreAuthorization
• SIX.TimApi.Constants.TransactionType.Purchase
• SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
• SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
• SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
• SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
• SIX.TimApi.Constants.TransactionType.Refunding
• SIX.TimApi.Constants.TransactionType.Reservation
• SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

setOmnichannelMerchantId

public void setOmnichannelMerchantId(String omnichannelMerchantId)

The OmnichannelMerchantId is used to identify the merchant on a Omnichannel host. This field is not used for Saferpay, but is for example for Ogone. Mandatory for (can not be null):

Conditional for (can be null):

• SIX.TimApi.Constants.TransactionType.Credit

Forbidden (has to be always null):

• SIX.TimApi.Constants.TransactionType.AdjustReservation
• SIX.TimApi.Constants.TransactionType.CancelReservation
• SIX.TimApi.Constants.TransactionType.DebtRecovery
• SIX.TimApi.Constants.TransactionType.FinalizePurchase
• SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
• SIX.TimApi.Constants.TransactionType.PurchaseReservation
• SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
• SIX.TimApi.Constants.TransactionType.Reversal
• SIX.TimApi.Constants.TransactionType.AccountVerification
• SIX.TimApi.Constants.TransactionType.ActivateCard
• SIX.TimApi.Constants.TransactionType.AuthorizeCredit
• SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
• SIX.TimApi.Constants.TransactionType.CashAdvance
• SIX.TimApi.Constants.TransactionType.CollectPoints
• SIX.TimApi.Constants.TransactionType.Combined
• SIX.TimApi.Constants.TransactionType.Funding
• SIX.TimApi.Constants.TransactionType.Giro
• SIX.TimApi.Constants.TransactionType.Load
• SIX.TimApi.Constants.TransactionType.LoadVoucher
• SIX.TimApi.Constants.TransactionType.PreAuthorization
• SIX.TimApi.Constants.TransactionType.Purchase
• SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
• SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
• SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
• SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
• SIX.TimApi.Constants.TransactionType.Refunding
• SIX.TimApi.Constants.TransactionType.Reservation
• SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

setAgeToCheck

public void setAgeToCheck(Long ageToCheck)

Set age to verify to allow transaction or null to disable age check. Mandatory for (can not be null):

Conditional for (can be null):

• SIX.TimApi.Constants.TransactionType.PreAuthorization
• SIX.TimApi.Constants.TransactionType.Purchase
• SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
• SIX.TimApi.Constants.TransactionType.Reservation

Forbidden (has to be always null):

• SIX.TimApi.Constants.TransactionType.AdjustReservation
• SIX.TimApi.Constants.TransactionType.CancelReservation
• SIX.TimApi.Constants.TransactionType.Credit
• SIX.TimApi.Constants.TransactionType.DebtRecovery
• SIX.TimApi.Constants.TransactionType.FinalizePurchase
• SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
• SIX.TimApi.Constants.TransactionType.PurchaseReservation
• SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
• SIX.TimApi.Constants.TransactionType.Reversal
• SIX.TimApi.Constants.TransactionType.AccountVerification
• SIX.TimApi.Constants.TransactionType.ActivateCard
• SIX.TimApi.Constants.TransactionType.AuthorizeCredit
• SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
• SIX.TimApi.Constants.TransactionType.CashAdvance
• SIX.TimApi.Constants.TransactionType.CollectPoints
• SIX.TimApi.Constants.TransactionType.Combined
• SIX.TimApi.Constants.TransactionType.Funding
• SIX.TimApi.Constants.TransactionType.Giro
• SIX.TimApi.Constants.TransactionType.Load
• SIX.TimApi.Constants.TransactionType.LoadVoucher
• SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
• SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
• SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
• SIX.TimApi.Constants.TransactionType.Refunding
• SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

getAgeToCheck

public Long getAgeToCheck()

Age to verify to allow transaction or null to disable age check. Mandatory for (can not be null):

Conditional for (can be null):

• SIX.TimApi.Constants.TransactionType.PreAuthorization
• SIX.TimApi.Constants.TransactionType.Purchase
• SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
• SIX.TimApi.Constants.TransactionType.Reservation

Forbidden (has to be always null):

• SIX.TimApi.Constants.TransactionType.AdjustReservation
• SIX.TimApi.Constants.TransactionType.CancelReservation
• SIX.TimApi.Constants.TransactionType.Credit
• SIX.TimApi.Constants.TransactionType.DebtRecovery
• SIX.TimApi.Constants.TransactionType.FinalizePurchase
• SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
• SIX.TimApi.Constants.TransactionType.PurchaseReservation
• SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
• SIX.TimApi.Constants.TransactionType.Reversal
• SIX.TimApi.Constants.TransactionType.AccountVerification
• SIX.TimApi.Constants.TransactionType.ActivateCard
• SIX.TimApi.Constants.TransactionType.AuthorizeCredit
• SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
• SIX.TimApi.Constants.TransactionType.CashAdvance
• SIX.TimApi.Constants.TransactionType.CollectPoints
• SIX.TimApi.Constants.TransactionType.Combined
• SIX.TimApi.Constants.TransactionType.Funding
• SIX.TimApi.Constants.TransactionType.Giro
• SIX.TimApi.Constants.TransactionType.Load
• SIX.TimApi.Constants.TransactionType.LoadVoucher
• SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
• SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
• SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
• SIX.TimApi.Constants.TransactionType.Refunding
• SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

getAuthCode

public String getAuthCode()

Returns:

the authCode

setAuthCode

public void setAuthCode(String authCode)

If the underlying payment protocol supports/requests it, for referencing a previous transaction that shall be refunded. Mandatory for (can not be null):

Conditional for (can be null):

• SIX.TimApi.Constants.TransactionType.Credit

Forbidden (has to be always null):

• SIX.TimApi.Constants.TransactionType.PreAuthorization
• SIX.TimApi.Constants.TransactionType.Purchase
• SIX.TimApi.Constants.TransactionType.PurchaseWithCashback
• SIX.TimApi.Constants.TransactionType.Reservation
• SIX.TimApi.Constants.TransactionType.AdjustReservation
• SIX.TimApi.Constants.TransactionType.CancelReservation
• SIX.TimApi.Constants.TransactionType.DebtRecovery
• SIX.TimApi.Constants.TransactionType.FinalizePurchase
• SIX.TimApi.Constants.TransactionType.PurchasePhoneAuthorized
• SIX.TimApi.Constants.TransactionType.PurchaseReservation
• SIX.TimApi.Constants.TransactionType.PurchaseReservationPhoneAuthorized
• SIX.TimApi.Constants.TransactionType.Reversal
• SIX.TimApi.Constants.TransactionType.AccountVerification
• SIX.TimApi.Constants.TransactionType.ActivateCard
• SIX.TimApi.Constants.TransactionType.AuthorizeCredit
• SIX.TimApi.Constants.TransactionType.AuthorizeDeposit
• SIX.TimApi.Constants.TransactionType.CashAdvance
• SIX.TimApi.Constants.TransactionType.CollectPoints
• SIX.TimApi.Constants.TransactionType.Combined
• SIX.TimApi.Constants.TransactionType.Funding
• SIX.TimApi.Constants.TransactionType.Giro
• SIX.TimApi.Constants.TransactionType.Load
• SIX.TimApi.Constants.TransactionType.LoadVoucher
• SIX.TimApi.Constants.TransactionType.PurchaseForcedAcceptance
• SIX.TimApi.Constants.TransactionType.PurchaseMailOrdered
• SIX.TimApi.Constants.TransactionType.PurchasePhoneOrdered
• SIX.TimApi.Constants.TransactionType.Refunding
• SIX.TimApi.Constants.TransactionType.Unload

Transactions will fail if one of the above mentioned restrictions are violated.

toString

public String toString()

String representation for debugging purpose.

Overrides:

toString in class Object

createSavedState

public com.six.timapi.internal.TimSavedState createSavedState()

For internal use only.