On this page

latest contributor to this doc

Last Edit:

@smk762

Close Lightning Channel

API-v2lightning::channels::close_channel

Closes a Lightning Network channel with a remote node.

ParameterTypeRequiredDefaultDescription
coinstring-The ticker of the coin for the channel to close.
channel_idstring-The channel ID to close.
forcebooleanfalseIf true, the channel will be force-closed.
target_heightinteger-The target block height for closing the channel.

ParameterTypeDescription
statusstringStatus message (e.g., Channel closed successfully).
idintRequest identifier.

lightning::channels::close_channel

POST
lightning::channels::close_channel
{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "lightning::channels::close_channel",
  "params": {
    "coin": "tBTC-lightning",
    "channel_id": "1234567890abcdef",
    "force": true
  },
  "id": 1
}