Sample - Stripe API
GET/v1/financial_connections/sessions/{session}

Retrieve a Financial Connections session

Retrieves a Financial Connections session by its identifier. Use expand to request expanded fields in the returned session object. The session includes collected accounts, requested permissions, and the client secret used to launch the client-side authentication flow.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
sessionstringrequired
The unique identifier of the Financial Connections session. Maximum 5000 characters.
expandarray<string>optional
Fields to expand in the response. Each value can be up to 5000 characters.

2 status codes
200Returns the Financial Connections session, including its identifier, collected accounts, permissions, and client secret.
account_holderobjectoptional
The account holder for whom accounts are collected in this session.
accountsobjectrequired
The accounts that were collected as part of this Session.
bank_account_tokenobjectoptional
Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our [recommended payments integrations](https://docs.stripe.com/payments) to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way. If you can't use client-side tokenization, you can also create tokens using the API with either your publishable or secret API key. If your integration uses this method, you're responsible for any PCI compliance that it might require, and you must keep your secret API key safe. Unlike with client-side tokenization, your customer's information isn't sent directly to Stripe, so we can't determine how it's handled or stored. You can't store or use tokens more than once. To store card or bank account information for later use, create [Customer](https://docs.stripe.com/api#customers) objects or [External accounts](/api#external_accounts). [Radar](https://docs.stripe.com/radar), our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization.
client_secretstringoptional
A value that will be passed to the client to launch the authentication flow.
filtersobjectoptional
idstringrequired
Unique identifier for the object.
limitsobjectoptional
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
manual_entryobjectoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:financial_connections.session
permissionsarray<string>required
Permissions requested for accounts collected during this session.
prefetcharray<string>optional
Data features requested to be retrieved upon account creation.
return_urlstringoptional
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.
defaultReturned when the request cannot be processed; the response contains an error object with an error type and related details.
errorobjectrequired

Error handling

session must be a string no longer than 5000 characters. Each expand value must also be no longer than 5000 characters; the request body does not define any fields.