FrameSDK/com.framepayments.framesdk.onboardingsessions/OnboardingSessionResponses/OnboardingSession

OnboardingSession

data class OnboardingSession(val id: String?, val accountId: String?, val clientSecret: String?, val returnUrl: String?, val steps: List<String>?, val sessionObject: String?, val expiresAt: Long?, val livemode: Boolean?, val url: String?)

The onboarding session returned by POST /v1/onboarding_sessions.

Constructors

OnboardingSession

constructor(id: String?, accountId: String?, clientSecret: String?, returnUrl: String?, steps: List<String>?, sessionObject: String?, expiresAt: Long?, livemode: Boolean?, url: String?)

Properties

@SerializedName(value = "account_id")

val accountId: String?

The account the session onboards.

@SerializedName(value = "client_secret")

val clientSecret: String?

The onboarding-session token (onb_sess_…) passed to the onboarding flow as its clientSecret.

@SerializedName(value = "expires_at")

val expiresAt: Long?

The Unix timestamp at which the session token expires.

val id: String?

The unique identifier of the onboarding session.

val livemode: Boolean?

true for live-mode sessions, false in sandbox.

@SerializedName(value = "return_url")

val returnUrl: String?

Where the account holder is redirected after completion, if provided.

@SerializedName(value = "object")

val sessionObject: String?

The object type. Always "onboarding_session".

val steps: List<String>?

The ordered onboarding steps for the session.

val url: String?

The hosted redirect URL for the account holder.