FrameSDK/com.framepayments.framesdk/FrameResult

FrameResult

sealed class FrameResult

Outcome of a Frame UI flow (checkout, cart, onboarding).

Completed.id carries the resource id produced by the flow: FrameCheckoutView / FrameCartView → Transfer id. OnboardingContainerView → the selected PaymentMethod id, or empty string if the flow completed without one.
Cancelled is emitted when the user dismisses the surface without completing.
Failed is emitted for terminal errors that can't be retried in-flow.

Inheritors

Types

data object Cancelled : FrameResult

Emitted when the user dismisses the surface without completing.

data class Completed(val id: String) : FrameResult

Emitted when the user completes the flow. id is the resource produced by the flow.

data class Failed(val error: Throwable) : FrameResult

Emitted for terminal errors that cannot be retried in-flow.