Package-level declarations

Types

Link copied to clipboard

The AlternativePaymentData class contains data about the alternative payment method that was used in a transaction.

Link copied to clipboard

Contains information concerning the authorisation of a transaction.

Link copied to clipboard

The authorisation method specifies how a transaction was authorised.

Link copied to clipboard

The authorising entity specifies who authorised a transaction.

Link copied to clipboard

The CardPaymentData class contains data about the payment card that was used in a transaction.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class DccData

Contains data about the converted amount and currency of a transaction where Dynamic Currency Conversion was used.

Link copied to clipboard

Indicates the Debit / Credit selection for the transaction.

Link copied to clipboard

Possible reasons for transactions being declined.

Link copied to clipboard
class EmvData

Contains EMV information about a card used in a transaction.

Link copied to clipboard
abstract class PaymentData

Base class for payment data classes.

Link copied to clipboard

Payment methods.

Link copied to clipboard
Link copied to clipboard
class PurchaseRequest(currencyId: Int = 0, totalAmount: Long = 0, saleId: String = "", loyaltyApplications: Array<String> = emptyArray(), paymentMethod: String = "", cashBackAmount: Long = 0, tipAmount: Long = 0, maximumTipAmount: Long = -1, maximumTipPercent: Long = -1, allowSkipTip: SkipTipOptions = SkipTipOptions.YES) : TransactionRequest

Represents a standard purchase request.

Link copied to clipboard

Represents a standard purchase response.

Link copied to clipboard
class RefundRequest(currencyId: Int = 0, totalAmount: Long = 0, saleId: String = "", loyaltyApplications: Array<String> = emptyArray(), paymentMethod: String = "", transactionReference: String = "") : TransactionRequest

Represents a refund transaction request.

Link copied to clipboard

Represents a refund transaction response.

Link copied to clipboard
class ReversalRequest(currencyId: Int = 0, totalAmount: Long = 0, saleId: String = "", loyaltyApplications: Array<String> = emptyArray(), paymentMethod: String = "") : TransactionRequest

Represents a reversal transaction request.

Link copied to clipboard

If tipping is enabled for a transaction, these are the options that can be set to govern if and how the customer is allowed to skip tipping.

Link copied to clipboard
class TransactionAmounts(totalAmount: Long = 0, cashBackAmount: Long = 0, vatAmount: Long = 0, cashAdvanceChargeAmount: Long = 0, tipAmount: Long = 0)

The TransactionAmounts class contains different type of amounts used in a transaction. The main use case for this class is when update of the transaction amount is needed for a pending transaction.

Link copied to clipboard

Error values for a transaction.

Link copied to clipboard
abstract class TransactionRequest(currencyId: Int = 0, totalAmount: Long = 0, saleId: String = "", loyaltyApplications: Array<String> = emptyArray(), paymentMethod: String = "")

Contains the details of a new transaction. This class should not be used directly by the POS application. The POS application should instantiate one of the subclasses of this class when a transaction should be performed.

Link copied to clipboard
open class TransactionResponse(error: TransactionError = TransactionError.NONE, errorMessage: String = "", saleId: String = "", transactionId: String = "", terminalId: String = "", terminalIdObscured: String = "", currencyId: Int = 0, totalAmount: Long = 0, merchantReceipt: String = "", cardholderReceipt: String = "", denialReasons: DenialReasons = DenialReasons.NONE, paymentData: PaymentData = CardPaymentData(), transactionTime: Date = Calendar.getInstance().time) : GenericResponse
Link copied to clipboard
Link copied to clipboard

Transaction types.

Link copied to clipboard

Verification methods.

Link copied to clipboard