Subscriptions
Withdrawal
Wallet withdrawal events
Private · account:withdrawals:read · 8 fields
Topic wallet/withdrawal
Wallet withdrawal events
Authentication required. Your API key must have permission
account:withdrawals:read. Subscribe after sendingauthenticate; private events delivered before auth are dropped.
Subscribe
Subscribe by calling the subscribe method with this topic.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": {
"topics": [
"wallet/withdrawal"
]
}
}Payload
Each notification carries the fields below in params.data.
currency*stringbtcnetwork*stringlightningbitcoinid*stringamount*numberfee*numberbalance*numberstatus*stringtxId*stringExample notification
The server pushes the JSON-RPC notification below for every event on this topic.
Notification
{
"jsonrpc": "2.0",
"method": "subscription",
"params": {
"topic": "wallet/withdrawal",
"data": {
"currency": "btc",
"network": "lightning",
"id": "string",
"amount": 0,
"fee": 0,
"balance": 0,
"status": "string",
"txId": "string"
}
}
}