FrameSDK/com.framepayments.framesdk.onboardingsessions/OnboardingSessionRequests/CreateOnboardingSessionRequest

CreateOnboardingSessionRequest

data class CreateOnboardingSessionRequest(val accountId: String, val steps: List<OnboardingSessionRequests.OnboardingSessionStep>? = null, val returnUrl: String? = null)

Request body for creating an onboarding session.

Constructors

Link copied to clipboard
constructor(accountId: String, steps: List<OnboardingSessionRequests.OnboardingSessionStep>? = null, returnUrl: String? = null)

Properties

Link copied to clipboard
@SerializedName(value = "account_id")
val accountId: String

The existing Frame account the session onboards.

Link copied to clipboard
@SerializedName(value = "return_url")
val returnUrl: String? = null

Where the account holder is redirected after completing the flow, or null.

Link copied to clipboard
val steps: List<OnboardingSessionRequests.OnboardingSessionStep>? = null

The ordered onboarding steps to present, or null to use the account's defaults.