Relink a Financial Connections account with your user's permissionVersion bêta publique
Prompt customers to repair data access, refresh expiring tokenized account numbers, and consent to new data permissions.
Your customers might need to reauthorize a previously linked Financial Connections account. You can prompt your customer to complete a relink session using the Stripe Dashboard or the API to:
| Reactivate an account to restore data access | Accounts might become inactive when users change their password, revoke your access, or when institutions change authentication or MFA requirements. The Financial Connections Account resource contains status-related details, including why an account is inactive, and whether you can relink it to reactivate it. After your customer reactivates an account, you can request up-to-date balance, transaction, or ownership information. |
| Refresh expiring tokenized account numbers | When tokenized account numbers expire or are revoked by the institution, you can’t initiate payments or payouts using the expired account details. Relinking an account with an expired TAN requests a new, active TAN from the institution. |
| Change the data permissions available on an account | When your customer links Financial Connections accounts for the first time, they consent to share data based on the permissions you specify. Customers must relink their accounts to consent to different permissions. |
You can request your users to relink in three ways. If you use Financial Connections to collect accounts for payments or payouts and your collected accounts meet the eligibility criteria, hosted relink is the quickest way to get started.
| Hosted relink (Dashboard) | Hosted relink (API) | API relink | |
|---|---|---|---|
| Integration effort | No code required to prompt your customer to relink an account. | Requires server-side code changes to prompt your customer to relink an account. | Requires client-side and server-side code changes to prompt your customer to relink an account. |
| Availability | Public preview. | Private preview. Email us to request access. | Public preview. |
| Presentation | Stripe sends an email to your customer with a link to a Stripe-hosted page to relink an account. | Stripe hosts a page for your customer to relink an account. When you create the session, you choose whether to receive the page URL in the response, or have Stripe email it to your customer on your behalf. | The relink flow is embedded in your website or application. |
| Eligible account criteria | You can relink any account, whether you use Financial Connections to verify the payment or payout account details or for data products. | ||
Relink frequency limits | You can send one relink request per account every 48 hours. Rate limits reset after your customer completes a relink request. | None when you provide the URL directly to your customer. When Stripe emails your customer on your behalf, you can send one relink email per account every 48 hours. Rate limits reset after your customer completes a relink request. | None |
| Refreshes tokenized account numbers | |||
| Updates data permissions | |||
| Account selection | When you send a relink email for an account, your customer must link exactly the same account. | When you create a hosted relink session for an account, your customer must link exactly the same account. | When you create a relink session, you specify whether or not your customer must relink a specific account. |
| Ideal for | Manually initiating account relinking for accounts used for payments or payouts. | Automating the process of initiating the relink flow for accounts used for payments or payouts. | Embedding the ability to relink one or more accounts on your website or in your application. |