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

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

POST /v1/financial_connections/accounts/:id/refresh
curl https://api.stripe.com/v1/financial_connections/accounts/fca_1MwVK82eZvKYlo2Cjw8FMxXf/refresh \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "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. Raises an error otherwise.

POST /v1/financial_connections/accounts/:id/subscribe
curl https://api.stripe.com/v1/financial_connections/accounts/fca_1NQay62eZvKYlo2C8dflHjWB/subscribe \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "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. Raises an error otherwise.

POST /v1/financial_connections/accounts/:id/unsubscribe
curl https://api.stripe.com/v1/financial_connections/accounts/fca_1NQayH2eZvKYlo2CMBkU6Y9s/unsubscribe \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "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
  }
}

Account Owner 

Describes an owner of an account.

Endpoints

Session 

A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

Endpoints