Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

Create a Session 

Financial Connections
Session
Create a Session

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_holderobjectRequired

    The account holder to link accounts for.

    • account_holder.typeenumRequired

      Type of account holder to collect accounts for.

    • account_holder.accountstring

      The ID of the Stripe account whose accounts will be retrieved. Should only be present if type is account.

    • account_holder.customerstring

      The ID of the Stripe customer whose accounts will be retrieved. Should only be present if type is customer.

  • permissionsarray of stringsRequired

    List of data features that you would like to request access to.

    Possible values are balances, transactions, ownership, and payment_method.

  • filtersobject

    Filters to restrict the kinds of accounts to collect.

    • filters.account_subcategoriesarray of enums

      Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: checking, savings, mortgage, line_of_credit, credit_card.

      Possible enum values
      checking

      The account is a checking account.

      credit_card

      The account represents a credit card.

      line_of_credit

      The account represents a line of credit.

      mortgage

      The account represents a mortgage.

      savings

      The account is a savings account.

    • filters.countriesarray of strings

      List of countries from which to collect accounts.

  • prefetcharray 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_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.

POST /v1/financial_connections/sessions
curl https://api.stripe.com/v1/financial_connections/sessions \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "account_holder[type]"=customer \
  -d "account_holder[customer]"=cus_NiKSWdaFz2F6I0 \
  -d "permissions[]"=payment_method \
  -d "permissions[]"=balances \
  -d "filters[countries][]"=US
Response
{
  "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"
  ]
}