Update an External Account
Update an External Account. Only label and metadata are mutable; any other JSON key in the body is rejected with 400.
Authorizations
Token from POST /auth/token
Path Parameters
External Account ID (ext_ prefix).
Body
Partial update - only label and metadata are mutable. Financial / identity fields are immutable (re-pointing a destination is create-new + re-point). Any other JSON key in the body is rejected with 400.
Response
The request has succeeded.
A saved payment destination registered for a customer or one of their counterparties. Write-only secrets (full account number, full IBAN) are never present on reads, only their last-4 renderings.
The customer the account is registered for, also when one of their counterparties owns it.
The account's type-specific values.
External Account ID (ext_ prefix).
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$The account type; decides which details keys are present.
bankUs, bankIban, bankCanada, card, walletExternal The counterparty that owns the account. Left out when the account is the customer's own.
usd on bank accounts and cards. Left out on wallets, which list their assets in supportedDestinations.
Where this account can be paid, computed per account. A US bank account lists the rails it can receive on, narrowed by what your project and the platform enable; an account Erebor Bank, N.A. provisions reports ach, achSameDay and wire, so a missing rtp there means unverified, not refused. A wallet lists usdc and usdt on each network its family serves. Left out for IBAN and Canadian bank accounts and cards.
US bank accounts: rails the project has turned on that this account cannot be paid over, each with its reason.
Current lifecycle status. A transition to invalid always fires the externalAccount.statusChanged webhook.
active, pending, rejected, invalid, deleted, failed Why the account failed, was rejected or became invalid. Present only when status is failed, rejected or invalid.
Optional display label.
Free-form key-value pairs supplied at creation or update.
When the external account was registered.
When the external account was last updated.