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

Retrieve a Session

GET / v1 / financial_connections / sessions /:id

Retrieves the details of a Financial Connections Session

Parameters

No parameters.

Returns

Returns a Session object if a valid identifier was provided, and raises an error otherwise.

Response