FrameSDK/com.framepayments.framesdk.onboardingsessions/OnboardingSessionsAPI/createOnboardingSession

createOnboardingSession

suspend fun createOnboardingSession(request: OnboardingSessionRequests.CreateOnboardingSessionRequest): Pair<OnboardingSessionResponses.OnboardingSession?, NetworkingError?>

Deprecated

Server-only — call this from your backend with your secret key (sk_), not from the app. Provided only so the example app can mint a token for testing.

Creates an onboarding session and returns its onb_sess_… client secret.

Return

A Pair containing the decoded OnboardingSessionResponses.OnboardingSession on success, or a NetworkingError on failure.

Parameters

request

The request body specifying the account and onboarding steps.

fun createOnboardingSession(request: OnboardingSessionRequests.CreateOnboardingSessionRequest, completionHandler: (OnboardingSessionResponses.OnboardingSession?, NetworkingError?) -> Unit)

Deprecated

Server-only — call this from your backend with your secret key (sk_), not from the app. Provided only so the example app can mint a token for testing.

Callback variant of createOnboardingSession.

Parameters

request

The request body specifying the account and onboarding steps.

completionHandler

Invoked with the decoded OnboardingSessionResponses.OnboardingSession on success, or a NetworkingError on failure.