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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
filters Object No

Filters to restrict the kinds of accounts to collect.

filters.account_subcategories[] Array No
filters.countries[] Array No
expand[] Array No

Specifies which fields in the response should be expanded.

account_holder Object Yes

The account holder to link accounts for.

account_holder.account String No
account_holder.customer String No
account_holder.type String Yes

Possible values:

  • "account"
  • "customer"
permissions[] Array Yes

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

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

prefetch[] Array No

List of data features that you would like to retrieve upon account creation.

return_url String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.