TransactionData
public class TransactionData : CustomStringConvertible
Contains configuration for transaction used by {@link Terminal#transaction} or {@link Terminal#transactionAsync}.
-
Create transaction data.
Declaration
Swift
public init()
-
Create copy of transaction data.
Declaration
Swift
public init(data: TransactionData)
-
Allows the EFT Terminal to enable DCC function. Use null to not use this parameter.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.adjustReservation
- CTransactionType.cashAdvance
- CTransactionType.debtRecovery
- CTransactionType.preAuthorization
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.reservation
Forbidden (has to be always nil):
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.initTransaction
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.purchase
- CTransactionType.refunding
- CTransactionType.reversal
- CTransactionType.unload
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var dccAllowed: Bool?
-
Timestamp of the original transaction. Use null to not use this parameter.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.authorizeCredit
- CTransactionType.credit
- CTransactionType.load
- CTransactionType.refunding
Forbidden (has to be always nil):
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.initTransaction
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var trxOriginalDate: TimeDate?
-
ECR sequence counter. Use null to not use this parameter.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.initTransaction
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var ecrSeqCounter: Int?
-
Partial approval is allowed. Use null to not use this parameter.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.adjustReservation
- CTransactionType.cashAdvance
- CTransactionType.combined
- CTransactionType.debtRecovery
- CTransactionType.giro
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseWithCashback
- CTransactionType.reservation
Forbidden (has to be always nil):
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.collectPoints
- CTransactionType.credit
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.initTransaction
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.refunding
- CTransactionType.reversal
- CTransactionType.unload
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var partialApprovalAllowed: Bool?
-
Transaction reference defined by the terminal. Use null to not use this parameter.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.credit
- CTransactionType.finalizePurchase
- CTransactionType.load
- CTransactionType.refunding
Forbidden (has to be always nil):
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.debtRecovery
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.initTransaction
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var transRef: Int?
-
Transaction sequence number defined by the terminal. Use null to not use this parameter.
Mandatory for (can not be nil):
- CTransactionType.reversal
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.finalizePurchase
Forbidden (has to be always nil):
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.initTransaction
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.unload
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var transSeq: Int?
-
- Petrol: Reference from the card.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.preAuthorization
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var cardRef: String?
-
- Acquirer identifier. Uniquely identifies the acquirer.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
Forbidden (has to be always nil):
- CTransactionType.activateCard
- CTransactionType.collectPoints
- CTransactionType.funding
- CTransactionType.initTransaction
- CTransactionType.loadVoucher
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.unload
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var acqId: Int64?
-
- Contains the transaction reference from the acquirer.
Mandatory for (can not be nil):
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.debtRecovery
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.refunding
- CTransactionType.unload
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseWithCashback
- CTransactionType.reservation
- CTransactionType.reversal
Forbidden (has to be always nil):
- CTransactionType.initTransaction
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var acqTransRef: String?
-
- 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 nil):
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.debtRecovery
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.refunding
- CTransactionType.unload
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseWithCashback
- CTransactionType.reservation
- CTransactionType.reversal
Forbidden (has to be always nil):
- CTransactionType.initTransaction
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public func setAcqTransRef(acqId: Int64, trxRefNo: Int)
-
- Transaction reference from the terminal.
Mandatory for (can not be nil):
- CTransactionType.finalizePurchase
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.initTransaction
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var trmTransRef: String?
-
Tip is allowed for purchase transactions. Use null to not use this parameter.
This parameter is only used if {@link com.six.timapi.constants.Guides#GASTRO} is enabled.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.reservation
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var tipAllowed: Bool?
-
- Phone authorization code.
Mandatory for (can not be nil):
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchaseReservationPhoneAuthorized
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.collectPoints
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.refunding
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.giro
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseWithCashback
- CTransactionType.reservation
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var phoneAuthCode: String?
-
- Petrol, Unattended: Language
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.balanceInquiry
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.clientIdentification
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.initTransaction
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.sendCardCommand
- CTransactionType.startCheckout
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.accountVerification
- CTransactionType.finalizePurchase
- CTransactionType.reversal
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var language: String?
-
SIX Transaction Reference Number.
Declaration
Swift
public var sixTrxRefNum: String?
-
SIX Transaction Reference Number for integrators using MPD Client.
Declaration
Swift
public func setSixTrxRefNum(acqId: Int64, trxRefNum: String)
-
Saferpay alias.
Declaration
Swift
public var saferpayAlias: String?
-
Saferpay recurring enabled.
Declaration
Swift
public var saferpayRecurring: Bool
-
- 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 nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var multiCurrencyFlag: Bool?
-
- Defines if NGV usage is mandatory or optional if card supports it. *
- Available if {@link Guides#AUSTRIAN_USE_CASES} is enabled.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var ngvMode: CNgvMode?
-
- Defines the clearing delay of the PurchaseNGV transaction. *
- Available if {@link Guides#AUSTRIAN_USE_CASES} is enabled.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var ngvClearingDelay: Int
-
- 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.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.initTransaction
- CTransactionType.purchaseReservation
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var cvc2: Int?
-
- 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.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.purchaseReservation
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var appExpirationDate: TimeDate?
-
- 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 nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.initTransaction
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var installmentAllowed: Bool?
-
- 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 nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var deferredAuthInd: Bool?
-
- Transaction reasno to setup credential on file.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.initTransaction
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var transactionReason: CTransactionReason?
-
- Sub transactions.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.combined
Forbidden (has to be always nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.credit
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var subTransactions: [SubTransaction]
-
- Allowed accounts.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.credit
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseWithCashback
Forbidden (has to be always nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.adjustReservation
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.balanceInquiry
- CTransactionType.cancelReservation
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.reversal
- CTransactionType.unload
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var allowedAccounts: Set<CAllowedAccounts>?
-
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 nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.reversal
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var tokenPan: String?
-
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 nil):
Conditional for (can be nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.unload
Forbidden (has to be always nil):
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.reversal
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var tokenPanType: CTokenPanType?
-
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
- SIX.TimApi.Constants.TransactionType.FinalizePurchase
- SIX.TimApi.Constants.TransactionType.Purchase
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.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.
Declaration
Swift
public var omnichannelPaymentId: String?
-
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
- SIX.TimApi.Constants.TransactionType.FinalizePurchase
- SIX.TimApi.Constants.TransactionType.Purchase
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.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.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.
Declaration
Swift
public var omnichannelMerchantId: String?
-
Age to check.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.purchase
- CTransactionType.purchaseWithCashback
- CTransactionType.preAuthorization
- CTransactionType.reservation
Forbidden (has to be always nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.credit
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneOrdered
- CTransactionType.refunding
- CTransactionType.unload
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.reversal
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var ageToCheck: Int?
-
If used by underlaying payment protocol.
Mandatory for (can not be nil):
Conditional for (can be nil):
- CTransactionType.credit
Forbidden (has to be always nil):
- CTransactionType.accountVerification
- CTransactionType.activateCard
- CTransactionType.authorizeCredit
- CTransactionType.authorizeDeposit
- CTransactionType.cashAdvance
- CTransactionType.collectPoints
- CTransactionType.combined
- CTransactionType.funding
- CTransactionType.giro
- CTransactionType.load
- CTransactionType.loadVoucher
- CTransactionType.preAuthorization
- CTransactionType.purchase
- CTransactionType.purchaseForcedAcceptance
- CTransactionType.purchaseMailOrdered
- CTransactionType.purchasePhoneOrdered
- CTransactionType.purchaseWithCashback
- CTransactionType.refunding
- CTransactionType.reservation
- CTransactionType.unload
- CTransactionType.adjustReservation
- CTransactionType.cancelReservation
- CTransactionType.debtRecovery
- CTransactionType.finalizePurchase
- CTransactionType.purchasePhoneAuthorized
- CTransactionType.purchaseReservation
- CTransactionType.purchaseReservationPhoneAuthorized
- CTransactionType.reversal
Transactions will fail if one of the above mentioned restrictions are violated.
Declaration
Swift
public var authCode: String?
-
This property indicates whether an omnichannel operation will be the final. Used for Capture Payments.
Mandatory for (can not be null):
Conditional for (can be null):
- SIX.TimApi.Constants.TransactionType.FinalizePurchase
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.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.
Declaration
Swift
public var isFinal: Bool
-
Textual representation.
Declaration
Swift
public var description: String { get }