Parameters

object

object

REQUIRED

The account_channels request object.

account

string

REQUIRED

The XRP Ledger account for which payment channels information is requested

destination_account

string

The destination account for filtering the payment channels associated with it

ledger_index

string

The ledger index to retrieve the payment channel information from

Returns

result

object

An object with the following fields:

account

string

The XRP Ledger account for which the payment channels information is provided

channels

array

A list of payment channels associated with the account

account

string

The XRP Ledger account

amount

integer

The amount of XRP allocated

balance

integer

The current balance

channel_id

string

The channel ID

destination_account

string

The destination account

public_key

string

The public key

public_key_hex

string

The hexadecimal representation of the public key

settle_delay

integer

The settlement delay

limit

integer

The maximum number of payment channels returned

ledger_hash

string

The hash of the ledger containing the payment channel information

ledger_index

integer

The index of the ledger containing the payment channel information

validated

boolean

Indicates if the information is from a validated ledger

status

string

The status of the request

warnings

array

(Optional) A list of warnings. Returned at the JSON-RPC response root on some servers and omitted from the result object

id

integer

The ID of the warning

message

string

The warning message

Request

1
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "account_channels",
6
  "params": [
7
    {
8
      "account": "r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE",
9
      "destination_account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
10
      "ledger_index": "validated"
11
    }
12
  ],
13
  "id": 1
14
}'

1
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "account_channels",
6
  "params": [
7
    {
8
      "account": "r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE",
9
      "destination_account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
10
      "ledger_index": "validated"
11
    }
12
  ],
13
  "id": 1
14
}'

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'account_channels',
4
    params: [{"account":"r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE","destination_account":"ra5nK24KXen9AHvsdFTKHSANinZseWnPcX","ledger_index":"validated"}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'account_channels',
4
    params: [{"account":"r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE","destination_account":"ra5nK24KXen9AHvsdFTKHSANinZseWnPcX","ledger_index":"validated"}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
import requests
2
import json
3

4
url = "https://docs-demo.xrp-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "account_channels",
9
  "params": [
10
    {
11
      "account": "r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE",
12
      "destination_account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
13
      "ledger_index": "validated"
14
    }
15
  ],
16
  "id": 1
17
})
18
headers = {
19
  'Content-Type': 'application/json'
20
}
21

22
response = requests.request("POST", url, headers=headers, data=payload)
23

24
print(response.text)

1
import requests
2
import json
3

4
url = "https://docs-demo.xrp-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "account_channels",
9
  "params": [
10
    {
11
      "account": "r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE",
12
      "destination_account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
13
      "ledger_index": "validated"
14
    }
15
  ],
16
  "id": 1
17
})
18
headers = {
19
  'Content-Type': 'application/json'
20
}
21

22
response = requests.request("POST", url, headers=headers, data=payload)
23

24
print(response.text)

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "account_channels",
11
  params: [{"account":"r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE","destination_account":"ra5nK24KXen9AHvsdFTKHSANinZseWnPcX","ledger_index":"validated"}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "account_channels",
11
  params: [{"account":"r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE","destination_account":"ra5nK24KXen9AHvsdFTKHSANinZseWnPcX","ledger_index":"validated"}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

Response

1
{
2
  "result": {
3
    "account": "r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE",
4
    "ledger_hash": "FE51E76B5948B60B847B5A1ECFF57C1EAF0FACDE7E408D5A1BEB1648F0D80E96",
5
    "ledger_index": 102609803,
6
    "validated": true,
7
    "limit": 200,
8
    "channels": [],
9
    "status": "success"
10
  },
11
  "warnings": [
12
    {
13
      "id": 2001,
14
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
15
    }
16
  ]
17
}

1
{
2
  "result": {
3
    "account": "r4AZpDKVoBxVcYUJCWMcqZzyWsHTteC4ZE",
4
    "ledger_hash": "FE51E76B5948B60B847B5A1ECFF57C1EAF0FACDE7E408D5A1BEB1648F0D80E96",
5
    "ledger_index": 102609803,
6
    "validated": true,
7
    "limit": 200,
8
    "channels": [],
9
    "status": "success"
10
  },
11
  "warnings": [
12
    {
13
      "id": 2001,
14
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
15
    }
16
  ]
17
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free