Sessions

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

Was this section helpful? Yes No

Create a Session

POST / v1 / financial_connections / sessions

Retrieve a Session

GET / v1 / financial_connections / sessions /:id

The Session object

Attributes

id string Unique identifier for the object.
object string, value is "financial_connections.session" String representing the object’s type. Objects of the same type share the same value.
account _ holder nullable object The account holder for whom accounts are collected in this session.
accounts object The accounts that were collected as part of this Session.
bank _ account _ token nullable object Information about the account if the user chose to enter details manually.
client _ secret nullable string A value that will be passed to the client to launch the authentication flow.
filters nullable object Filters applied to this session that restrict the kinds of accounts to collect.
limits nullable object Preview feature Settings for configuring Session-specific limits.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
manual _ entry nullable object Preview feature Settings for configuring manual entry of account details for this Session.
permissions array of enums Permissions requested for accounts collected during this session. Possible enum values balances Requests access for balance data on accounts collected in this session. ownership Requests access for ownership data on accounts collected in this session. payment_method Requests permission for the creation of a payment method from an account collected in this session. transactions Requests access for transaction data on accounts collected in this session.
prefetch nullable array of enums Data features requested to be retrieved upon account creation. Possible enum values balances Requests to prefetch balance data on accounts collected in this session. ownership Requests to prefetch ownership data on accounts collected in this session. transactions Requests to prefetch transaction data on accounts collected in this session.
return _ url nullable string 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.

The Session object

Create a Session

POST / v1 / financial_connections / sessions

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

Parameters

account _ holder object Required The account holder to link accounts for.
permissions array of strings Required List of data features that you would like to request access to. Possible values are balances, transactions, ownership, and payment_method.
filters object Filters to restrict the kinds of accounts to collect.
limits object Preview feature Settings for configuring Session-specific limits.
manual _ entry object Preview feature Customize manual entry behavior
prefetch array of enums List of data features that you would like to retrieve upon account creation. Possible enum values balances Requests to prefetch balance data on accounts collected in this session. ownership Requests to prefetch ownership data on accounts collected in this session. transactions Requests to prefetch transaction data on accounts collected in this session.
return _ url string 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.

Returns

Returns the Session object.

Response