Freeze Wallet

Freeze a wallet to prevent outgoing transactions for a set period. See the Guide.

Freeze a wallet for a set period of time. While frozen, wallet users, including admins, cannot make outgoing transactions from the wallet, but the wallet can still receive incoming transactions. This is useful if you need to immediately stop all spending without deleting the wallet. For example, you may want to freeze wallets during organizational changes or during periods when your enterprise needs to reduce spending.

You cannot unfreeze a wallet before the specified time expires. Ensure that you will not need to spend from the wallet during the specified period. BitGo measures the duration of the freeze in seconds.

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

API Reference

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

curl -X POST \
  https://app.bitgo-test.com/api/v2/$COIN/wallet/$WALLET_ID/freeze \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
  "duration": 0
}'

// 1. Freeze Wallet
import * as dotenv from "dotenv";
import {EnvironmentName} from "bitgo";
import {BitGoAPI} from "@bitgo/sdk-api";
import {Tbtc4} from "@bitgo/sdk-coin-btc";

dotenv.config();

const bitgo = new BitGoAPI({
    env: process.env.ENV as EnvironmentName,
    accessToken: process.env.TESTNET_ACCESS_TOKEN
});

const coin = 'tbtc4';
bitgo.register(coin, Tbtc4.createInstance);

const walletId = process.env.WALLET_ID;

async function main() {
    const walletInstance = await bitgo.coin(coin).wallets().get({id: walletId});
    // BitGo measures the duration of the freeze in seconds
    walletInstance.freeze({ otp: '0000000' }).then(function (freeze) {
      console.dir(freeze);
    });
}

main().catch((err) => console.error(err));

Response

// 1. Freeze Wallet Response
{
  "time": "2019-08-24T14:15:22Z",
  "expires": "2019-08-24T14:15:22Z"
}