Messages
{
"jsonrpc": "2.0",
"method": "private/subscribe",
"id": 42,
"params": {
"channels": [
"user.lock"
]
}
}{
"data": {
"locked": true,
"currency": "ALL"
}
}User
user.lock
Notifications when the account is locked or unlocked.
Use this channel to react to account lock events (e.g., pause trading workflows) and to detect when access is restored.
Messages
{
"jsonrpc": "2.0",
"method": "private/subscribe",
"id": 42,
"params": {
"channels": [
"user.lock"
]
}
}{
"data": {
"locked": true,
"currency": "ALL"
}
}Subscription Request
type:object
Client sends subscription request to subscribe to notification channel. Please refer to Notification page for more information.
jsonrpc
type:string
required
2.0
id
type:integer
required
method
type:enum
required
Available options:
public/subscribe, private/subscribeparams
type:object
required
channels
type:array
required
item
type:string
Subscription Notification Data
type:object
Server sends subscription notification data
data
type:object
required
currency
type:string
required
Currency on which account lock has changed, ALL if changed for all currencies
locked
type:boolean
required
Value is set to 'true' when user account is locked in currency
Was this page helpful?