A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- account_
holdernullable object The account holder for whom accounts are collected in this session.
- accountsobject
The accounts that were collected as part of this Session.
- client_
secretstring A value that will be passed to the client to launch the authentication flow.
- filtersnullable object
Filters applied to this session that restrict the kinds of accounts to collect.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - permissionsarray of enums
Permissions requested for accounts collected during this session.
Possible enum valuesbalances
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.
- prefetchnullable array of enums
Data features requested to be retrieved upon account creation.
Possible enum valuesbalances
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_
urlnullable 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.
{ "id": "fcsess_1MwtnGLkdIwHu7ixs7NPQ7dq", "object": "financial_connections.session", "account_holder": { "customer": "cus_NiKSWdaFz2F6I0", "type": "customer" }, "accounts": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/financial_connections/accounts" }, "client_secret": "fcsess_client_secret_KRJTKvCY3IKoYTrW18EazcO3", "filters": { "countries": [ "US" ] }, "livemode": false, "permissions": [ "balances", "payment_method" ]}
To launch the Financial Connections authorization flow, create a Session
. The session’s client_
can be used to launch the flow using Stripe.js.
Parameters
- account_
holderobjectRequired The account holder to link accounts for.
- permissionsarray of stringsRequired
List of data features that you would like to request access to.
Possible values are
balances
,transactions
,ownership
, andpayment_
.method - filtersobject
Filters to restrict the kinds of accounts to collect.
- prefetcharray of enums
List of data features that you would like to retrieve upon account creation.
Possible enum valuesbalances
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_
urlstring 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.
{ "id": "fcsess_1MwtnGLkdIwHu7ixs7NPQ7dq", "object": "financial_connections.session", "account_holder": { "customer": "cus_NiKSWdaFz2F6I0", "type": "customer" }, "accounts": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/financial_connections/accounts" }, "client_secret": "fcsess_client_secret_KRJTKvCY3IKoYTrW18EazcO3", "filters": { "countries": [ "US" ] }, "livemode": false, "permissions": [ "balances", "payment_method" ]}
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.
{ "id": "fcsess_1MwtnGLkdIwHu7ixs7NPQ7dq", "object": "financial_connections.session", "account_holder": { "customer": "cus_NiKSWdaFz2F6I0", "type": "customer" }, "accounts": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/financial_connections/accounts" }, "client_secret": "fcsess_client_secret_KRJTKvCY3IKoYTrW18EazcO3", "filters": { "countries": [ "US" ] }, "livemode": false, "permissions": [ "balances", "payment_method" ]}
A Transaction represents a real transaction that affects a Financial Connections Account balance.