The Account object

Attributes

id string Unique identifier for the object.
object string, value is "financial_connections.account" String representing the object’s type. Objects of the same type share the same value.
account _ holder nullable object The account holder that this account belongs to.
account _ numbers nullable array of objects Details about the account numbers.
balance nullable object The most recent information about the account’s balance.
balance _ refresh nullable object The state of the most recent attempt to refresh the account balance.
category enum The type of the account. Account category is further divided in subcategory. Possible enum values cash The account represents real funds held by the institution (e.g. a checking or savings account). credit The account represents credit extended by the institution (e.g. a credit card or mortgage). investment The account represents investments, or any account where there are funds of unknown liquidity. other The account does not fall under the other categories.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
display _ name nullable string A human-readable name that has been assigned to this account, either by the account holder or by the institution.
institution _ name string The name of the institution that holds this account.
last4 nullable string The last 4 digits of the account number. If present, this will be 4 numeric characters.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
ownership nullable string Expandable The most recent information about the account’s owners.
ownership _ refresh nullable object The state of the most recent attempt to refresh the account owners.
permissions nullable array of enums The list of permissions granted by this account. Possible enum values balances Allows accessing balance data from the account. ownership Allows accessing ownership data from the account. payment_method Allows the creation of a payment method from the account. transactions Allows accessing transactions data from the account.
status enum The status of the link to the account. Possible enum values active Stripe is able to retrieve data from the Account without issues. disconnected Account connection has been terminated through the disconnect API or an end user request. inactive Stripe cannot retrieve data from the Account.
status _ details object Preview feature Details on the status of the account.
subcategory enum 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. Possible enum values checking The account is a checking account. credit_card The account represents a credit card. line_of_credit The account represents a line of credit. mortgage The account represents a mortgage. other The account does not fall under any of the other subcategories. savings The account is a savings account.
subscriptions nullable array of enums The list of data refresh subscriptions requested on this account. Possible enum values transactions Subscribes to periodic transactions data refreshes from the account.
supported _ payment _ method _ types array of enums The PaymentMethod type (s) that can be created from this account. Possible enum values link A link PaymentMethod can be created. us_bank_account A us_bank_account PaymentMethod can be created.
transaction _ refresh nullable object The state of the most recent attempt to refresh the account transactions.

The Account object

{ "id": "fca_1MwVK82eZvKYlo2Cjw8FMxXf", "object": "financial_connections.account", "account_holder": { "customer": "cus_9s6XI9OFIdpjIg", "type": "customer" }, "balance": null, "balance_refresh": null, "category": "cash", "created": 1681412208, "display_name": "Sample Checking Account", "institution_name": "StripeBank", "last4": "6789", "livemode": false, "ownership": null, "ownership_refresh": null, "permissions": [], "status": "active", "subcategory": "checking", "subscriptions": [], "supported_payment_method_types": [ "us_bank_account" ], "transaction_refresh": null}

Retrieve an Account

GET / v1 / financial_connections / accounts /:id

Retrieves the details of a Financial Connections Account.

Parameters

No parameters.

Returns

Returns an Account object if a valid identifier was provided, and raises an error otherwise.

Response

{ "id": "fca_1MwVK82eZvKYlo2Cjw8FMxXf", "object": "financial_connections.account", "account_holder": { "customer": "cus_9s6XI9OFIdpjIg", "type": "customer" }, "balance": null, "balance_refresh": null, "category": "cash", "created": 1681412208, "display_name": "Sample Checking Account", "institution_name": "StripeBank", "last4": "6789", "livemode": false, "ownership": null, "ownership_refresh": null, "permissions": [], "status": "active", "subcategory": "checking", "subscriptions": [], "supported_payment_method_types": [ "us_bank_account" ], "transaction_refresh": null}

List Accounts

GET / v1 / financial_connections / accounts

Returns a list of Financial Connections Account objects.

Parameters

account _ holder object If present, only return accounts that belong to the specified account holder. account_holder[customer] and account_holder[account] are mutually exclusive.
session string If present, only return accounts that were collected as part of the given session.

More parameters

ending _ before string
limit integer
starting _ after string

Returns

A dictionary with a data property that contains an array of up to limit Account objects, starting after account starting_after. Each entry in the array is a separate Account object. If no more accounts are available, the resulting array will be empty. This request will raise an error if more than one of account_holder[account], account_holder[customer], or session is specified.

Response