API OverviewAPI EndpointsAccounts

Update a bank account

Updates a bank account (both PLAID and EXTERNAL accounts). Can be used to set account status to inactive for soft-delete.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

idstringRequired
The ID of the bank account to update

Query Parameters

entityIdstringRequired
The ID of the entity that owns the account

Request

This endpoint expects an object.
statusenumOptional

The account status - inactive performs soft-delete

Allowed values:
account_namestringOptional
The account name
current_balancedoubleOptional
The current balance of the account
metadataobjectOptional
Additional metadata for the account

Response

Bank account updated successfully

Errors