Skip to main content

account_channels RPC Method

Returns information about the Payment Channels associated with XRP Ledger account

Updated on
Oct 04, 2023

account_channels RPC Method

Parameters

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
ledger_hash
string
The hash of the ledger containing the payment channel information
limit
integer
It limits the number of transactions to retrieve
marker
string
A marker value to paginate through the results

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
A list of warnings
id
integer
The ID of the warning
message
string
The warning message
Request
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free