sdk/au.com.woolworths.village.sdk.model/TransactionSummary

TransactionSummary

Summary information of a transaction

interface TransactionSummary : Payment

Types

PaymentStatus

Allowed states that a transaction can be in

enum PaymentStatus : Enum<TransactionSummary.PaymentStatus>

PaymentType

Allowed types of transactions

enum PaymentType : Enum<TransactionSummary.PaymentType>

SummaryRollback

enum SummaryRollback : Enum<TransactionSummary.SummaryRollback>

UsedPaymentInstrument

An instrument used for a transaction

interface UsedPaymentInstrument

UsedPaymentInstrumentTransaction

A subtransaction associated with a payment instrument

interface UsedPaymentInstrumentTransaction

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

clientReference

An optional client reference associated with the transaction.

abstract val clientReference: String?

executionTime

Timestamp of when the transaction occurred

abstract val executionTime: OffsetDateTime

grossAmount

The gross amount to be paid. Must be positive except for refunds

abstract override val grossAmount: BigDecimal

instruments

The instruments used to make the payment. For refunds and cash back amounts will be negative

abstract val instruments: List<TransactionSummary.UsedPaymentInstrument>

merchantReferenceId

The unique reference for the payment as defined by the Merchant

abstract override val merchantReferenceId: String

paymentRequestId

The ID of this payment request

abstract override val paymentRequestId: String

refundReason

The reason provided for the refund. Only provided for REFUND transactions

abstract val refundReason: String?

rollback

The rollback state of this transaction

abstract val rollback: TransactionSummary.SummaryRollback?

status

The current status of the transactions

abstract val status: TransactionSummary.PaymentStatus

subTransactions

Array of transaction responses returned by downstream processes

abstract val subTransactions: List<Any>?

transactionId

The ID of the transaction

abstract val transactionId: String

type

The type of transaction.

abstract val type: TransactionSummary.PaymentType

Inheritors

CustomerTransactionSummary

MerchantTransactionSummary