Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

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 object 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 throw an error if more than one of account_holder[account], account_holder[customer], or session is specified.

GET /v1/financial_connections/accounts
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const accounts = await stripe.financialConnections.accounts.list({
  limit: 3,
});
Response
{
  "object": "list",
  "url": "/v1/financial_connections/accounts",
  "has_more": false,
  "data": [
    {
      "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
    }
  ]
}

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 throws an error otherwise.

POST /v1/financial_connections/accounts/:id/disconnect
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const account = await stripe.financialConnections.accounts.disconnect(
  'fca_1MwVK82eZvKYlo2Cjw8FMxXf'
);
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": "disconnected",
  "subcategory": "checking",
  "subscriptions": [],
  "supported_payment_method_types": [
    "us_bank_account"
  ],
  "transaction_refresh": null
}

Refresh Account data 

Refreshes the data associated with a Financial Connections Account.

Parameters

  • featuresarray of enumsRequired

    The list of account features that you would like to refresh.

    Possible enum values
    balance

    Balance data from the account

    ownership

    Ownership data from the account

    transactions

    Transactions data from the account

Returns

Returns an Account object if a valid identifier was provided and if you have sufficient permissions to that account. Throws an error otherwise.

POST /v1/financial_connections/accounts/:id/refresh
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const account = await stripe.financialConnections.accounts.refresh(
  'fca_1MwVK82eZvKYlo2Cjw8FMxXf',
  {
    features: ['balance'],
  }
);
Response
{
  "id": "fca_1MwVK82eZvKYlo2Cjw8FMxXf",
  "object": "financial_connections.account",
  "account_holder": {
    "customer": "cus_9s6XI9OFIdpjIg",
    "type": "customer"
  },
  "balance": null,
  "balance_refresh": {
    "status": "pending",
    "last_attempted_at": 1681422295
  },
  "category": "cash",
  "created": 1681412208,
  "display_name": "Sample Checking Account",
  "institution_name": "StripeBank",
  "last4": "6789",
  "livemode": false,
  "ownership": null,
  "ownership_refresh": null,
  "permissions": [],
  "status": "pending",
  "subcategory": "checking",
  "subscriptions": [],
  "supported_payment_method_types": [
    "us_bank_account"
  ],
  "transaction_refresh": null
}

Subscribe to data refreshes for an Account 

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

Parameters

  • featuresarray of enumsRequired

    The list of account features to which you would like to subscribe.

    Possible enum values
    transactions

    Transactions data from the account

Returns

Returns an Account object if a valid identifier was provided and if you have sufficient permissions to that account. Throws an error otherwise.

POST /v1/financial_connections/accounts/:id/subscribe
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const account = await stripe.financialConnections.accounts.subscribe(
  'fca_1NQay62eZvKYlo2C8dflHjWB',
  {
    features: ['transactions'],
  }
);
Response
{
  "id": "fca_1NQay62eZvKYlo2C8dflHjWB",
  "object": "financial_connections.account",
  "account_holder": {
    "customer": "cus_9s6XKzkNRiz8i3",
    "type": "customer"
  },
  "balance": null,
  "balance_refresh": null,
  "category": "cash",
  "created": 1688583746,
  "display_name": "Sample Checking Account",
  "institution_name": "StripeBank",
  "last4": "6789",
  "livemode": false,
  "ownership": null,
  "ownership_refresh": null,
  "permissions": [],
  "status": "active",
  "subcategory": "checking",
  "subscriptions": [
    "transactions"
  ],
  "supported_payment_method_types": [
    "us_bank_account"
  ],
  "transaction_refresh": {
    "id": "fctxnref_OD10iHSd7eaheDkeabbQfnJ7",
    "status": "pending",
    "last_attempted_at": 1625337296
  }
}

Unsubscribe from data refreshes for an Account 

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

Parameters

  • featuresarray of enumsRequired

    The list of account features from which you would like to unsubscribe.

    Possible enum values
    transactions

    Transactions data from the account

Returns

Returns an Account object if a valid identifier was provided and if you have sufficient permissions to that account. Throws an error otherwise.

POST /v1/financial_connections/accounts/:id/unsubscribe
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const account = await stripe.financialConnections.accounts.unsubscribe(
  'fca_1NQayH2eZvKYlo2CMBkU6Y9s',
  {
    features: ['transactions'],
  }
);
Response
{
  "id": "fca_1NQayH2eZvKYlo2CMBkU6Y9s",
  "object": "financial_connections.account",
  "account_holder": {
    "customer": "cus_9s6XKzkNRiz8i3",
    "type": "customer"
  },
  "balance": null,
  "balance_refresh": null,
  "category": "cash",
  "created": 1688583757,
  "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": {
    "id": "fctxnref_OD10EqMBikeOrWm7JW44fdpo",
    "status": "succeeded",
    "last_attempted_at": 1625337296
  }
}