Honeycluster Docs – List payment channels for an account

Account Methods

List payment channels for an account

wss://honeycluster.io

rpc method: account_channels

Returns information about the payment channels owned by the specified account, optionally filtered by destination.

Try it now

Response · account_channels WS Response

{
  "result": {
    "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "channels": [
      {
        "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
        "amount": "100000000",
        "balance": "0",
        "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
        "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
        "settle_delay": 86400
      }
    ],
    "ledger_index": 89012345
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

account_channels WS Request

application/json

List payment channels for an account

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`account`	string	The account that is the source (owner) of the payment channels to retrieve.
`destination_account`	string	Filter channels by destination account address.
`ledger_index`	object	A ledger index (sequence number) or shortcut string identifying which ledger to use.
`ledger_hash`	string	256-bit hex hash identifying a specific ledger version.
`limit`	integer	Limit the number of payment channels returned. Default varies by server.
`marker`	object	Opaque pagination marker from a previous response. Pass unchanged to fetch the next page.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "account_channels",
  "id": 1,
  "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
  "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
  "ledger_index": "validated"
}

Response Message

account_channels WS Response

application/json

WebSocket response for account_channels

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Example

Json

{
  "result": {
    "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "channels": [
      {
        "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
        "amount": "100000000",
        "balance": "0",
        "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
        "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
        "settle_delay": 86400
      }
    ],
    "ledger_index": 89012345
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

const ws = new WebSocket('wss://honeycluster.io');

ws.addEventListener('open', () => {
  const request = {
    "command": "account_channels",
    "id": 1,
    "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "ledger_index": "validated"
  };
  ws.send(JSON.stringify(request));
});

ws.addEventListener('message', (event: MessageEvent<string>) => {
  const response: unknown = JSON.parse(event.data);
  console.log(response);
  ws.close();
});

Response · account_channels WS Response

{
  "result": {
    "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "channels": [
      {
        "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
        "amount": "100000000",
        "balance": "0",
        "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
        "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
        "settle_delay": 86400
      }
    ],
    "ledger_index": 89012345
  },
  "status": "success",
  "type": "response",
  "id": 1
}