Sample - Stripe API
GET/v1/linked_accounts/{account}

Retrieve a Financial Connections Account

Retrieves a Financial Connections Account by its identifier. Use account to select the external account whose institution, category, balances, ownership, and granted permissions you need, and use expand for additional response fields.

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

2 parameters
accountstringrequired
The unique identifier of the Financial Connections Account, limited to 5000 characters.
expandarray<string>optional
Fields to expand in the response; each value can contain up to 5000 characters.

2 status codes
200Returns the Financial Connections Account, including its institution, category, account details, balance and ownership information, permissions, and live-mode state.
account_holderobjectoptional
The account holder that this account belongs to.
account_numbersarray<BankConnectionsResourceAccountNumberDetails>optional
Details about the account numbers.
balanceobjectoptional
The most recent information about the account's balance.
balance_refreshobjectoptional
The state of the most recent attempt to refresh the account balance.
categorystringrequired
The type of the account. Account category is further divided in `subcategory`.
Allowed:cashcreditinvestmentother
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
display_namestringoptional
A human-readable name that has been assigned to this account, either by the account holder or by the institution.
idstringrequired
Unique identifier for the object.
institution_namestringrequired
The name of the institution that holds this account.
last4stringoptional
The last 4 digits of the account number. If present, this will be 4 numeric characters.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:financial_connections.account
ownershipstringoptional
The most recent information about the account's owners.
ownership_refreshobjectoptional
The state of the most recent attempt to refresh the account owners.
permissionsarray<string>optional
The list of permissions granted by this account.
statusstringrequired
The status of the link to the account.
Allowed:activedisconnectedinactive
status_detailsobjectoptional
subcategorystringrequired
If `category` is `cash`, one of: - `checking` - `savings` - `other` If `category` is `credit`, one of: - `mortgage` - `line_of_credit` - `credit_card` - `other` If `category` is `investment` or `other`, this will be `other`.
Allowed:checkingcredit_cardline_of_creditmortgageothersavings
subscriptionsarray<string>optional
The list of data refresh subscriptions requested on this account.
supported_payment_method_typesarray<string>required
The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
transaction_refreshobjectoptional
The state of the most recent attempt to refresh the account transactions.
defaultReturned when the API reports an error; the response contains an `error` object with a `type` field.
errorobjectrequired

Error handling

account must be a string no longer than 5000 characters that identifies the Financial Connections Account to retrieve. Each value in expand must be a string no longer than 5000 characters.