Delete a fund wallet. (admin access required)

Soft-deletes a fund wallet and disables its distribution config. Unclaimed source-level requests continue through another enabled fund wallet, or are cancelled when none remains. Does NOT move funds. A wallet with a broadcast or ambiguous distribution in flight cannot be deleted, even with force=true; wait for the transaction to settle first. Also refuses with 409 while the wallet still holds ADA or native assets, because deletion makes the mnemonic unexportable through the API — withdraw every asset first. Pass force=true only to skip the balance check, accepting that any remaining balance is recoverable only with direct database access.

delete/fund-wallet

Request

Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
URL: ./../api/v1/fund-wallet
Auth: API key in header token

Request body

idstring required

Fund wallet id to delete

forceboolean

Delete even if the wallet still holds funds, or if the balance cannot be checked. Deletion makes the mnemonic unexportable, so the remaining balance would be recoverable only with direct database access

Example request

{
  "id": "cuid_v2_auto_generated",
  "force": false
}

Response

Fund wallet deleted

status'success' required

Example response

{
  "status": "success",
  "data": {
    "id": "cuid_v2_auto_generated"
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.