Sample - Stripe API
POST/v1/financial_connections/accounts/{account}/refresh

Refresh Financial Connections account data

Triggers a refresh of selected data for a Financial Connections account. Supply features to specify which account data to refresh, and use expand to request expanded response fields. The response includes the account and the state of the latest refresh operations.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
accountstringrequired
The unique identifier of the Financial Connections account to refresh. Maximum 5000 characters.

Form-encoded account refresh options.

expandarray<string>optional
Specifies which fields in the response should be expanded.
featuresarray<string>required
The list of account features that you would like to refresh.

2 status codes
200Returns the refreshed Financial Connections account, including account details and the latest refresh states for requested features.
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 request cannot be processed; the response contains an error object with an error type and related details.
errorobjectrequired

Error handling

features is required and must contain values from: balance, ownership, or transactions. account must be a string no longer than 5000 characters, and each expand value must also be no longer than 5000 characters.