Available in
Stripe platforms in the US can enable Stripe Financial Connections within the Stripe-hosted onboarding form by following these steps:
- Navigate to your External Account settings, where you manage optional Connect onboarding features.
- For connected accounts where your platform collects account information when requirements change, including for Custom accounts, you must allow Stripe-hosted onboarding to collect external account details. Under Stripe-hosted onboarding for Custom accounts, allow Stripe to collect external account information by turning on the toggle.
- Under How will bank account details be collected?, select Financial Connections.
- (Optional) Request permission to access additional data on the accounts instantly verified with Financial Connections, such as balances, ownership details, and transactions. If you opt to request this additional information, you’ll be prompted to sign up for Stripe Financial Connections.
- Navigate to your payout onboarding settings, where you manage optional Connect onboarding features.
- For connected accounts where your platform collects account information when requirements change, including for Custom accounts, you must allow Stripe-hosted onboarding to collect external account details. Under Allow Stripe to collect bank account information from connected accounts, allow Stripe to collect external account information by turning on the toggle.
- Under Collection method, select Financial Connections.
- (Optional) Request permission to access additional data on the accounts instantly verified with Financial Connections, such as balances, ownership details, and transactions. If you opt to request this additional information, you’ll be prompted to sign up for Stripe Financial Connections.
When external account detail collection is enabled, all connected accounts are prompted to authenticate their bank account using the Stripe-hosted modal UI embedded within the onboarding form.
A Connect onboarding flow using Stripe Financial Connections to collect a payout account.
If a connected account can’t instantly verify their bank account using Financial Connections, the verification process automatically falls back to manual entry:
A Connect onboarding flow using the Stripe Financial Connections modal to collect a payout account using manual entry.
After onboarding, the specified bank account automatically attaches to the connected account.
Retrieve data on a Financial Connections account Server-side
You can determine if your user linked a Financial Connections Account by retrieving any linked Financial Connections Accounts using their connected account ID. Be sure to specify their account ID in the Stripe-Account
header.
curl -G https://api.stripe.com/v1/financial_connections/accounts \
-u "sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
-H "Stripe-Account: " \
-d "account_holder[account]"=
This returns an API response similar to the following:
{
"object": "list",
"data": [
{
"id": "fca_zbyrdjTrwcYZJZc6WBs6GPid",
"object": "financial_connections.account",
"account_holder": {
"account": '{{CONNECTED_ACCOUNT_ID}}'
,
"type": "account"
},
...
"supported_payment_method_types": [
"us_bank_account"
]
}
...
]
}
If any Financial Connections accounts are listed, it indicates that the connected account linked them during the onboarding process. You can use the id
value to access or refresh the data you specified in your External Account settings. To protect the privacy of your connected account’s data, you can only access the data you specified.
To start retrieving account data, follow the guides for balances, ownership, and transactions. On all subsequent account retrieval and refresh requests, be sure to include the Stripe-Account
header with the connected account ID:
curl https://api.stripe.com/v1/financial_connections/accounts/fca_zbyrdjTrwcYZJZc6WBs6GPid/refresh \
-u "sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
-H "Stripe-Account: " \
-d "features[]"=balance