Inttegro SDK for Android/com.inttegro.payments/CheckoutEvent

CheckoutEvent

data class CheckoutEvent(val type: CheckoutEvent.Type, val occurredAt: Instant, val flowId: String, val sequence: Int, val order: CheckoutOrder? = null, val action: CheckoutAction? = null, val failure: CheckoutFailure? = null, val complete: Boolean? = null, val paymentMethod: String? = null)(source)

One ordered, application-facing event from a Checkout presentation.

Constructors

constructor(type: CheckoutEvent.Type, occurredAt: Instant, flowId: String, sequence: Int, order: CheckoutOrder? = null, action: CheckoutAction? = null, failure: CheckoutFailure? = null, complete: Boolean? = null, paymentMethod: String? = null)

Types

enum Type : Enum<CheckoutEvent.Type>

Canonical Checkout lifecycle transition.

Properties

val action: CheckoutAction?

Sanitized payer action when further interaction is required.

val complete: Boolean?

Whether the currently entered payment details are complete.

val failure: CheckoutFailure?

Sanitized failure details for attempt or terminal failures.

val flowId: String

Identifier shared by events from one presentation.

val occurredAt: Instant

Time the SDK observed the transition.

val order: CheckoutOrder?

Client-safe Order snapshot when the event concerns an Order.

val paymentMethod: String?

Selected payment-method family for change events.

val sequence: Int

Monotonic position within the presentation.

val type: CheckoutEvent.Type

Lifecycle transition represented by this event.