Stripe: Link account sessions schemas

← Link account sessions operations · All schemas

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

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
account_holder	object	Required within parent	The account holder to link accounts for.
account_holder.account	string	Optional	Maximum length: 5000
account_holder.customer	string	Optional	Maximum length: 5000
account_holder.customer_account	string	Optional	Maximum length: 5000
account_holder.type	string	Required within parent	One of: account, customer
expand	array	Optional	Specifies which fields in the response should be expanded.
expand[]	string	Each item	Maximum length: 5000
filters	object	Optional	Filters to restrict the kinds of accounts to collect.
filters.account_subcategories	array	Optional
filters.account_subcategories[]	string	Each item	One of: checking, credit_card, line_of_credit, mortgage, savings
filters.country	string	Optional	Maximum length: 5000
filters.require_payment_method_support	string	Optional	One of: all, at_least_one, none
limits	object	Optional	Settings for configuring Session-specific limits.
limits.accounts	JSON	Required within parent
limits.accounts (anyOf 1)	integer	Alternative
limits.accounts (anyOf 2)	string	Alternative	One of:
manual_entry	object	Optional	Customize manual entry behavior
manual_entry.mode	string	Optional	One of: automatic, disabled
permissions	array	Required within parent	List of data features that you would like to request access to. Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.
permissions[]	string	Each item	One of: balances, ownership, payment_method, transactions Maximum length: 5000
prefetch	array	Optional	List of data features that you would like to retrieve upon account creation.
prefetch[]	string	Each item	One of: balances, ownership, transactions
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

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 — 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

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