commons/com.teya.unifiedepossdk/PaymentStateDetails

PaymentStateDetails

@ObjCName(name = "TeyaPaymentStateDetails", exact = true)

data class PaymentStateDetails(val eposTransactionId: String, val amount: Int, val tip: Int?, val currency: String, val state: PaymentState, val inProgressState: InProgressState?, val gatewayTransactionId: GatewayTransactionId? = null, val reason: PaymentStateReason? = null, val debugErrorMessage: String? = null, val metadata: PaymentStateDetails.Metadata? = null, val transactionTimestamp: Long? = null, val wasUnsubscribed: Boolean = false)

Class holding all information about the state of the payment.

Constructors

PaymentStateDetails

constructor(eposTransactionId: String, amount: Int, tip: Int?, currency: String, state: PaymentState, inProgressState: InProgressState?, gatewayTransactionId: GatewayTransactionId? = null, reason: PaymentStateReason? = null, debugErrorMessage: String? = null, metadata: PaymentStateDetails.Metadata? = null, transactionTimestamp: Long? = null, wasUnsubscribed: Boolean = false)

Types

Metadata

data class Metadata(val card: PaymentStateDetails.Metadata.Card?, val entryMode: PaymentStateDetails.Metadata.EntryMode?, val verificationMethod: PaymentStateDetails.Metadata.VerificationMethod?, val applicationId: String?, val merchantAcquiringId: String?, val responseCode: String?, val authorisationCode: String?, val dcc: PaymentStateDetails.Metadata.Dcc?)

Additional metadata related to the payment, such as card details or response codes. Useful to prepare a consolidated receipt on ePOS side. Available if payment finished successfully.

Properties

amount

val amount: Int

the final total amount that was charged in minor units. In final successful states, it can be different from the requested one, only if a tip was added in the Payments app.

currency

val currency: String

the currency of the tip and amount.

debugErrorMessage

val debugErrorMessage: String?

useful for logging and reporting issues with Teya.

eposTransactionId

val eposTransactionId: String

The ePOS id passed in the makePayment call.

gatewayPaymentId

val gatewayPaymentId: GatewayPaymentId?

The gatewayTransactionId when this is a payment, or null for a refund.

gatewayRefundId

val gatewayRefundId: GatewayRefundId?

The gatewayTransactionId when this is a refund, or null for a payment.

gatewayTransactionId

val gatewayTransactionId: GatewayTransactionId?

Teya backend id for the transaction created. This field will not be null on PaymentState.Successful state. It is a GatewayPaymentId for a payment and a GatewayRefundId for a refund — read it through gatewayPaymentId or gatewayRefundId.

inProgressState

val inProgressState: InProgressState?

more granular state for PaymentState.InProgress main state. Always null for All In One integration. See InProgressState.

isFinal

val isFinal: Boolean

If true, you won't get any more state changes for this payment, the payment has reached a final state.

metadata

val metadata: PaymentStateDetails.Metadata?

Additional metadata related to the payment, such as card details or response codes. Useful to prepare a consolidated receipt on ePOS side. Available if payment finished successfully.

reason

val reason: PaymentStateReason?

The reason for the current payment state, if applicable. See PaymentStateReason.

state

val state: PaymentState

The current state of the payment, see PaymentState.

tip

val tip: Int?

the final tip amount in minor units. In final successful states, it can be different from the requested one, only if a tip was added in the Payments app.

transactionTimestamp

val transactionTimestamp: Long?

The timestamp (in milliseconds since epoch) when the transaction occurred.

wasUnsubscribed

val wasUnsubscribed: Boolean

If true, it means that the listener was unsubscribed from, it serves as a final call to it so that even if you unsubscribe, you'll always get one final call.