Stripe: Retrieve a Session — financial Connections get Financial Connections Sessions Session

← Financial connections operations · Get started

Operation stripe.getfinancialconnectionssessionssession

Provider route: GET /v1/financial_connections/sessions/{session}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["financialConnections"]["getFinancialConnectionsSessionsSession"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.financialConnections.getFinancialConnectionsSessionsSession(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.financial_connections.get_financial_connections_sessions_session(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.session	string	Required within parent	Maximum length: 5000
query	object	Optional	Additional keys: not allowed
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a Session — link Account Sessions post Link Account Sessions — response body

Referenced models: Create a Session — link Account Sessions post Link Account Sessions — response body

Schemas

719 more schemas are linked from the tables above, on the schema pages.

Create a Session — link Account Sessions post Link Account Sessions — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
account_holder	JSON	Optional
account_holder (anyOf 1)	JSON	Alternative	The account holder for whom accounts are collected in this session.
account_holder (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Session — linkAccountSessions.postLinkAccountSessions — response body — account_holder / value / type: account, customer
account_holder (anyOf 2)	null	Alternative
accounts	object	Required within parent	The accounts that were collected as part of this Session.
accounts.data	array	Required within parent	Details about each object.
accounts.data[]	Model	Each item	Expand Subscribe to data refreshes for an Account — response body
accounts.has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
accounts.object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
accounts.url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/financial_connections/accounts
bank_account_token	Model	Optional	Expand Retrieve a token — response body
client_secret	JSON	Optional
client_secret (anyOf 1)	string	Alternative	A value that will be passed to the client to launch the authentication flow. Maximum length: 5000
client_secret (anyOf 2)	null	Alternative
filters	Model	Optional	Expand Create a Session — link Account Sessions post Link Account Sessions — response body — filters
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
limits	Model	Optional	Expand Create a Session — link Account Sessions post Link Account Sessions — response body — limits
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
manual_entry	Model	Optional	Expand Create a Session — link Account Sessions post Link Account Sessions — response body — manual entry
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: financial_connections.session
permissions	array	Required within parent	Permissions requested for accounts collected during this session.
permissions[]	string	Each item	Known values: balances, ownership, payment_method, transactions
prefetch	JSON	Optional
prefetch (anyOf 1)	array	Alternative	Data features requested to be retrieved upon account creation.
prefetch (anyOf 1)[]	string	Each item	Known values: balances, ownership, transactions
prefetch (anyOf 2)	null	Alternative
return_url	string	Optional	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. Maximum length: 5000

Referenced models: Create a Session — linkAccountSessions.postLinkAccountSessions — response body — account_holder / value / type: account, customer, Create a Session — link Account Sessions post Link Account Sessions — response body — filters, Create a Session — link Account Sessions post Link Account Sessions — response body — limits, Create a Session — link Account Sessions post Link Account Sessions — response body — manual entry, Subscribe to data refreshes for an Account — response body, Retrieve a token — response body

Create a Session — linkAccountSessions.postLinkAccountSessions — response body — account_holder / value / type: account, customer

Field	Type	Presence	Description and constraints
$	object	Root
account	JSON	Optional	The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`.
account (anyOf 1)	string	Alternative	Maximum length: 5000
account (anyOf 2)	Model	Alternative	Expand Create an account — response body
customer	JSON	Optional	The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`.
customer (anyOf 1)	string	Alternative	Maximum length: 5000
customer (anyOf 2)	Model	Alternative	Expand Create a customer — response body
customer_account	string	Optional	Maximum length: 5000
type	string	Required within parent	Type of account holder that this account belongs to. Known values: account, customer

Referenced models: Create an account — response body, Create a customer — response body

Create a Session — link Account Sessions post Link Account Sessions — response body — filters

Field	Type	Presence	Description and constraints
$	object	Root
account_subcategories	JSON	Optional
account_subcategories (anyOf 1)	array	Alternative	Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
account_subcategories (anyOf 1)[]	string	Each item	Known values: checking, credit_card, line_of_credit, mortgage, savings
account_subcategories (anyOf 2)	null	Alternative
country	JSON	Optional
country (anyOf 1)	string	Alternative	Country from which to filter accounts. Maximum length: 5000
country (anyOf 2)	null	Alternative
require_payment_method_support	string	Optional	Whether the Session should require that linked accounts support payments and retrieve account numbers before completion. Known values: all, at_least_one, none

Create a Session — link Account Sessions post Link Account Sessions — response body — limits

Field	Type	Presence	Description and constraints
$	object	Root
accounts	JSON	Required within parent
accounts (anyOf 1)	integer	Alternative	The number of accounts that can be linked in this Session.
accounts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a Session — link Account Sessions post Link Account Sessions — response body — manual entry

Field	Type	Presence	Description and constraints
$	object	Root
mode	string	Optional	Controls how manual entry of bank account details is presented to the user. Known values: automatic, disabled

Subscribe to data refreshes for an Account — response body — account numbers Details about the account numbers item

Field	Type	Presence	Description and constraints
$	object	Root
expected_expiry_date	JSON	Optional
expected_expiry_date (anyOf 1)	JSON	Alternative
expected_expiry_date (anyOf 1) (anyOf 1)	integer	Alternative	When the account number is expected to expire, if applicable. Format: unix-time
expected_expiry_date (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expected_expiry_date (anyOf 2)	null	Alternative
identifier_type	string	Required within parent	The type of account number associated with the account. Known values: account_number, tokenized_account_number
status	string	Required within parent	Whether the account number is currently active and usable for transactions. Known values: deactivated, expired, pending, transactable
supported_networks	array	Required within parent	The payment networks that the account number can be used for.
supported_networks[]	string	Each item	Known values: ach

Subscribe to data refreshes for an Account — response body — status details

Field	Type	Presence	Description and constraints
$	object	Root
active	Model	Optional	Expand Subscribe to data refreshes for an Account — response body — status details active

Referenced models: Subscribe to data refreshes for an Account — response body — status details active

Create an account — response body — groups The groups associated with the account payments pricing

Field	Type	Presence	Description and constraints
$	object	Root
payments_pricing	JSON	Optional
payments_pricing (anyOf 1)	string	Alternative	The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. Maximum length: 5000
payments_pricing (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: stripe.getfinancialconnectionssessionssession. Catalog operation: GetFinancialConnectionsSessionsSession. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source