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

ConnectBackend

interface ConnectBackend

The app's view of the server's Stripe Connect payout onboarding rail (roadmap #11) — mirrors PayoutBackend's shape: onboard/completeOnboarding do the server round-trips, status polls server-authoritative state. Implemented in core:network against core:protocol DTOs.

Real Connect onboarding is a KYC/OAuth-gated flow (see GatewayStatus.MOCK_MODE's own doc comment) — this app models only the honest onboard → pending → CONNECTED (via mock hosted-OAuth callback) lifecycle, never a fake instant CONNECTED.

Functions

Link copied to clipboard
abstract suspend fun completeOnboarding(onboardingId: String): ConnectAccount

The mock OAuth callback the hosted WebView return-URL triggers once onboarding is authorized.

Link copied to clipboard
abstract suspend fun onboard(): ConnectOnboarding

POST /connect/onboard. Returns the mock hosted OAuth URL to render + the onboarding id.

Link copied to clipboard
abstract suspend fun payout(accountId: String, amount: Money, idempotencyKey: String): PayoutSnapshot

POST /connect/{accountId}/payouts — pay out to a connected account via the existing payout rail.

Link copied to clipboard
abstract suspend fun status(accountId: String): ConnectAccount

GET /connect/{accountId} — poll the server-authoritative state.

Generated by Dokka
© 2026 Copyright