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.
A Tax Calculation allows you to calculate the tax to collect from your customer.
Related guide: Calculate tax in your custom payment flow
A Tax Registration
lets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax.
Stripe doesn’t register on your behalf with the relevant authorities when you create a Tax Registration
object. For more information on how to register to collect tax, see our guide.
Related guide: Using the Registrations API