API Reference

Update external bank account

patch
https://api.wingspan.app/v3/finance/external-bank-accounts/

Partially updates an external bank account (e.g. nickname, default flag). Setting verificationMethod: MicroDeposit on a manually entered account initiates micro-deposit verification when it has not already started. QuickBooks account-sync mappings are updated under integration.quickbooks; set an individual mapping id to null to clear it.

Requires a session with recent MFA step-up for BankAccountChange. If step-up is missing or expired, this operation returns 403 StepUpMfaRequired; create and verify an MFA challenge at /v3/platform/mfa-challenges with requiredFor: "BankAccountChange", then retry.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

External bank account ID

Body Params
string
boolean
string
enum

Completes or corrects the holder type for future payouts without changing the Checking/Savings account type.

Allowed:
string
enum

Initiates micro-deposit verification for a manually entered account that has not already started verification. Plaid is derived from provider-linked accounts and Manual is reserved for internal/back-office verification; neither is client-settable through this update request.

Allowed:
integration
object

External bookkeeping-system mappings for this bank account.

metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago

Did this page help you?