REST API›Wallet & Transact›Wallet

POST

Freeze the wallet for the given coin and wallet id.

Permissions:

  • spender for the given wallet and coin

Path Params

  • coin string required
    A cryptocurrency symbol or token ticker symbol

    at least 1 characters

  • walletId string required

    at least 1 characters · matches ^[0-9a-f]{32}$

Body Params

object

Freeze Wallet Request Body

Parameters for freezing a wallet, including duration and optional metadata.

  • duration number or string nullable required
    How long to freeze the wallet

    Defaults to 3600 (1 hour)

    ONE OF

    number

  • reason string enum
    Reason for freezing the wallet
    TxIntentMismatchTxIntentMismatchRecipientTxIntentMismatchContractTxIntentMismatchApprovalUserRequestAdminRequest
  • referenceId string
    Used for tracking purposes
  • metadata object
    Provides more context on why a wallet was frozen

    ONE OF

    string

Responses

200
OK

Response Body

object

  • time string date required
  • expires string date required
  • reason string enum
    Why a wallet was frozen
    TxIntentMismatchTxIntentMismatchRecipientTxIntentMismatchContractTxIntentMismatchApprovalUserRequestAdminRequest
  • referenceId string
    An optional reference ID for tracking purposes
  • adminOrUserId string
    The user who froze the wallet (could be a regular user or an admin)
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
403
Forbidden

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
409
Conflict

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
500
Internal Server Error

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id