Ctrl+K

Freeze the wallet for the given coin and wallet id.

post/api/v2/{coin}/wallet/{walletId}/freeze

Permissions:

  • spender for the given wallet and coin

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc
    Min length: >= 1 characters
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Request Body

durationOne ofrequired
How long to freeze the wallet
Default: 3600 (1 hour)
reason string
Reason for freezing the wallet
Allowed values: TxIntentMismatch TxIntentMismatchRecipient TxIntentMismatchContract TxIntentMismatchApproval UserRequest AdminRequest
referenceId string
Used for tracking purposes
metadataOne of
Provides more context on why a wallet was frozen

200 Response

time string <date>required
expires string <date>required
reason string
Why a wallet was frozen
Allowed values: TxIntentMismatch TxIntentMismatchRecipient TxIntentMismatchContract TxIntentMismatchApproval UserRequest AdminRequest
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 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

409 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

500 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id