payments-api/com.siddharth.kmp.paymentsapi/StubGateway

StubGateway

class StubGateway(config: StubGatewayConfig) : PaymentGateway

A Tier-4 "stub/docs-only" catalog entry: real enough to appear in the Lab list with an honest GatewayStatus.COMING_SOON badge and a web-researched doc, but with no working integration behind it (no backend adapter, no real or mock SDK call). pay always fails — nothing should ever actually invoke it in normal use since the UI badges it as not-yet-available, but the contract still has to return something rather than throw if it somehow is.

Constructors

StubGateway

constructor(config: StubGatewayConfig)

Properties

open override val id: GatewayId

Functions

pay

open suspend override fun pay(host: PaymentHost, prepared: PreparedPayment): PaymentResult

Launch the provider UI/intent and suspend until the user reaches a terminal state.

prepare

open suspend override fun prepare(created: CreatedOrder): PreparedPayment

Transform a backend-created order into this provider's session shape. The network round-trip already happened (the orchestrator owns PaymentBackend); most providers just repackage CreatedOrder.providerParams, but the call is suspend for providers that need an extra hop. Throws PaymentPreparationException on failure.