Delete Wallet

Delete a wallet from your enterprise. See the Guide.

Delete a wallet from your enterprise that you no longer want to use. Once you delete a wallet, you can no longer view or access it. However, the wallet remains visible and accessible to other wallet users. If you are the only wallet user, then the wallet must have a 0 balance before you can delete it. To fully remove a wallet, transfer all assets out and remove users before deleting.

Once deleted, the isDeleted boolean identifies wallets. If you need to restore a deleted wallet, contact BitGo support at support@bitgo.com.

Prerequisites: You must have completed the Get Started steps and have a wallet created through Create Wallets.

API Reference

// 1. Delete Wallet
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
export COIN="<COIN>"
export WALLET_ID="<WALLET_ID>"

curl -X DELETE \
  https://app.bitgo-test.com/api/v2/$COIN/wallet/$WALLET_ID \
  -H "Authorization: Bearer $ACCESS_TOKEN"

// 1. Delete Wallet
import { BitGoAPI } from '@bitgo/sdk-api';
import { Tstx } from '@bitgo/sdk-coin-stx';

// Fill in with actual access token
const accessToken = '<your_actual_access_token>';

const walletId = '<your_actual_wallet_id>';

// Initialize the SDK
const bitgo = new BitGoAPI({
  accessToken: accessToken,
  env: 'test',
});

const coin = '<your_coin_name>';
bitgo.register(coin, Tstx.createInstance);
const wallet = await bitgo.coin(coin).wallets().get({ id: walletId });
console.log('Wallet :', wallet);
const delWallet = await wallet.remove();
console.log('Wallet removed :', delWallet);

Response

// 1. Delete Wallet Response
{
  "admin": {
    "policy": {
      "id": "59cd72485007a239fb00282ed480da1f",
      "date": "2019-08-24T14:15:22Z",
      "label": "string",
      "latest": true,
      "rules": [
        {
          "id": "string",
          "lockDate": "2019-08-24T14:15:22Z",
          "mutabilityConstraint": "managed",
          "coin": "btc",
          "type": "advancedWhitelist",
          "condition": {
            "amountString": "2000000",
            "timeWindow": 2678400,
            "groupTags": [
              "59cd72485007a239fb00282ed480da1f"
            ],
            "excludeTags": [
              "59cd72485007a239fb00282ed480da1f"
            ]
          },
          "action": {
            "type": "deny",
            "approvalsRequired": 1,
            "userIds": [
              "59cd72485007a239fb00282ed480da1f"
            ]
          }
        }
      ],
      "version": 0
    }
  },
  "allowBackupKeySigning": true,
  "approvalsRequired": 1,
  "balanceString": "string",
  "buildDefaults": {
    "minFeeRate": 12000
  },
  "coin": "btc",
  "coinSpecific": {
    "creationFailure": [
      "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26"
    ],
    "pendingChainInitialization": true,
    "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM",
    "stellarUsername": "foo_bar@baz.com",
    "homeDomain": "bitgo.com",
    "stellarAddress": "foo_bar@baz.com*bitgo.com"
  },
  "custodialWallet": {},
  "custodialWalletId": "59cd72485007a239fb00282ed480da1f",
  "deleted": true,
  "disableTransactionNotifications": true,
  "enterprise": "59cd72485007a239fb00282ed480da1f",
  "freeze": {
    "time": "string",
    "expires": "string"
  },
  "id": "59cd72485007a239fb00282ed480da1f",
  "isCold": true,
  "keys": [
    "585951a5df8380e0e304a553",
    "585951a5df8380e0e30d645c",
    "585951a5df8380e0e30b6147"
  ],
  "label": "My Wallet",
  "m": 2,
  "n": 3,
  "nodeId": "59cd72485007a239fb00282ed480da1f",
  "receiveAddress": {
    "id": "59cd72485007a239fb00282ed480da1f",
    "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS",
    "chain": 1,
    "index": 0,
    "coin": "string",
    "lastNonce": -1,
    "wallet": "59cd72485007a239fb00282ed480da1f",
    "coinSpecific": {
      "xlm": {
        "memoId": "2000000",
        "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
      },
      "txlm": {
        "memoId": "2000000",
        "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
      }
    },
    "balance": {
      "updated": "2019-08-24T14:15:22Z",
      "balance": 50000,
      "balanceString": "50000",
      "totalReceived": 0,
      "totalSent": 0,
      "confirmedBalanceString": "40000",
      "spendableBalanceString": "40000"
    },
    "label": "Bob's Hot Wallet Address",
    "addressType": "p2sh"
  },
  "recoverable": true,
  "tags": [
    "59cd72485007a239fb00282ed480da1f"
  ],
  "spendableBalanceString": "string",
  "startDate": "string",
  "type": "cold",
  "users": [
    {
      "user": "55e8a1a5df8380e0e30e20c6",
      "permissions": [
        "admin",
        "view",
        "spend"
      ]
    }
  ],
  "customChangeKeySignatures": {
    "user": "string",
    "backup": "string",
    "bitgo": "string"
  },
  "multisigType": "onchain"
}