financial-connections/com.stripe.android.financialconnections.model/FinancialConnectionsSession

FinancialConnectionsSession

@Serializable
data class FinancialConnectionsSession : StripeModel, Parcelable

A Financial Connections Session is the secure way to programmatically launch the client-side modal that lets your users link their accounts.

Parameters

accounts
clientSecret

A value that will be passed to the client to launch the authentication flow.

id

Unique identifier for the object.

livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

bankAccountToken
manualEntry
paymentAccount
returnUrl

For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

status

The current state of the session.

statusDetails

Types

Link copied to clipboard
@Serializable(with = FinancialConnectionsSession.Status.Serializer::class)
enum Status : Enum<FinancialConnectionsSession.Status>

The current state of the session.

Link copied to clipboard
@Serializable
data class StatusDetails(val cancelled: FinancialConnectionsSession.StatusDetails.Cancelled? = null) : Parcelable

Properties

Link copied to clipboard
Link copied to clipboard
@SerialName(value = "client_secret")
val clientSecret: String
Link copied to clipboard
@SerialName(value = "id")
val id: String
Link copied to clipboard
@SerialName(value = "livemode")
val livemode: Boolean
Link copied to clipboard
@SerialName(value = "manual_entry")
val manualEntry: ManualEntry? = null
Link copied to clipboard
@SerialName(value = "payment_account")
@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
val paymentAccount: PaymentAccount? = null
Link copied to clipboard
@SerialName(value = "return_url")
val returnUrl: String? = null
Link copied to clipboard
@SerialName(value = "status")
val status: FinancialConnectionsSession.Status? = null
Link copied to clipboard
@SerialName(value = "status_details")
val statusDetails: FinancialConnectionsSession.StatusDetails? = null

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)