Accounts

A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.

Endpoints

GET/v1/financial_connections/accounts/:id

GET/v1/financial_connections/accounts

POST/v1/financial_connections/accounts/:id/disconnect

POST/v1/financial_connections/accounts/:id/refresh

POST/v1/financial_connections/accounts/:id/subscribe

POST/v1/financial_connections/accounts/:id/unsubscribe

The Account object

Attributes

idstring
Unique identifier for the object.

objectstring
String representing the object’s type. Objects of the same type share the same value.

account_holdernullable object
The account holder that this account belongs to.

balancenullable object
The most recent information about the account’s balance.

balance_refreshnullable object
The state of the most recent attempt to refresh the account balance.

categoryenum

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.

createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

display_namenullable string
A human-readable name that has been assigned to this account, either by the account holder or by the institution.

institution_namestring
The name of the institution that holds this account.

last4nullable string
The last 4 digits of the account number. If present, this will be 4 numeric characters.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

ownershipnullable stringExpandable
The most recent information about the account’s owners.

ownership_refreshnullable object
The state of the most recent attempt to refresh the account owners.

permissionsnullable 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.

statusenum
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.
inactive
Stripe cannot retrieve data from the Account.

subcategoryenum

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.

subscriptionsnullable 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_typesarray 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_refreshnullable object
The state of the most recent attempt to refresh the account transactions.

The Account object

{
  "id": "fca_1MwVK82eZvKYlo2Cjw8FMxXf",
  "object": "linked_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

Retrieves the details of an Financial Connections Account.

Parameters

No parameters.

Returns

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

GET /v1/financial_connections/accounts/:id

Server-side language

curl https://api.stripe.com/v1/financial_connections/accounts/fca_1MwVK82eZvKYlo2Cjw8FMxXf \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

{
  "id": "fca_1MwVK82eZvKYlo2Cjw8FMxXf",
  "object": "linked_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

Returns a list of Financial Connections Account objects.

Parameters

account_holderobject
If present, only return accounts that belong to the specified account holder. account_holder[customer] and account_holder[account] are mutually exclusive.

sessionstring
If present, only return accounts that were collected as part of the given session.

More parameters

ending_beforestring

limitinteger

starting_afterstring

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.

GET /v1/financial_connections/accounts

Server-side language

curl -G https://api.stripe.com/v1/financial_connections/accounts \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/financial_connections/accounts",
  "has_more": false,
  "data": [
    {
      "id": "fca_1MwVK82eZvKYlo2Cjw8FMxXf",
      "object": "linked_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
    }
    {...}
    {...}
  ],
}

Disconnect an Account

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

Parameters

No parameters.

Returns

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

POST /v1/financial_connections/accounts/:id/disconnect

Server-side language

curl -X POST https://api.stripe.com/v1/financial_connections/accounts/fca_1MwVK82eZvKYlo2Cjw8FMxXf/disconnect \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

{
  "id": "fca_1MwVK82eZvKYlo2Cjw8FMxXf",
  "object": "linked_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": "disconnected",
  "subcategory": "checking",
  "subscriptions": [],
  "supported_payment_method_types": [
    "us_bank_account"
  ],
  "transaction_refresh": null
}

Accounts

The Account object

Attributes

idstring

objectstring

account_holdernullable object

balancenullable object

balance_refreshnullable object

categoryenum

createdtimestamp

display_namenullable string

institution_namestring

last4nullable string

livemodeboolean

ownershipnullable stringExpandable

ownership_refreshnullable object

permissionsnullable array of enums

statusenum

subcategoryenum

subscriptionsnullable array of enums

supported_payment_method_typesarray of enums

transaction_refreshnullable object

Retrieve an Account

Parameters

Returns

List Accounts

Parameters

account_holderobject

sessionstring

More parametersExpand all

ending_beforestring

limitinteger

starting_afterstring

Returns

Disconnect an Account

Parameters

Returns

More parameters