Skip to main content

account_channels

POST
Returns the list of Payment Channels owned by an account.Only channels where the queried account is the source are returned.
param[0]
parametersobjectrequired
accountstringrequired
The address of the account that owns and funds the channel.
destination_accountstring
Returns only the channels whose destination is the specified account.
limitinteger
The number of channels to return. Pass a value between 10 and 400.
markerstring
A value that marks a pagination position. Pass the marker value from a previous response to retrieve the next page.Its format depends on the server implementation, so use it verbatim without interpreting its contents.
ledger_hashstring
The hash of the ledger version to use. Pass a 32-byte hex string.
ledger_indexoneOf
Specifies the ledger version to use. Pass a ledger index as an integer, or use one of the shortcut strings below.
  • validated: Uses the most recent ledger version validated by the network.
  • closed: Uses the most recent ledger version the server has closed. It may not be validated.
  • current: Uses the in-progress ledger version the server is currently building.
The ledger index of the version to use.
Responses
accountstring
The address of the account that owns and funds the channel.
The list of Payment Channels owned by the account.
accountstring
The address of the channel owner.
amountstring
The total amount held in the channel, in drops.
balancestring
The amount already paid out to the destination, in drops.
channel_idstring
The 64-character hex string that identifies the channel.
destination_accountstring
The address of the channel's destination account.
settle_delayinteger
The time the channel stays open after a close request, in seconds.
public_keystring
The base58-encoded public key.
public_key_hexstring
The hex-encoded public key.
expirationinteger
The mutable expiration time of the channel, in seconds since the Ripple Epoch.
cancel_afterinteger
The immutable expiration time of the channel, in seconds since the Ripple Epoch.
source_taginteger
The 32-bit tag that identifies the payment source.
destination_taginteger
The 32-bit tag that identifies the payment destination.
limitinteger
The number of channel objects returned.
markerstring
A value that marks a pagination position. Pass the marker value from a previous response to retrieve the next page.Its format depends on the server implementation, so use it verbatim without interpreting its contents.
ledger_hashstring
The hash of the ledger version used. Returned when a validated ledger version was queried.
ledger_indexinteger
The ledger index of the version used. Returned when a validated ledger version was queried.
ledger_current_indexinteger
The ledger index of the in-progress ledger. Returned when the current ledger was queried.
validatedboolean
Whether the response was derived from a validated ledger version.
codestringrequired
Code identifying the cause of the failed request.
messagestringrequired
Detailed message including the name and value of the invalid parameter.
{
  "code": "ERROR_CODE",
  "message": "Unauthorized"
}
cURL
curl -X POST 'https://xrpl-mainnet.nodit.io' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "method": "account_channels",
    "params": [
      {
        "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
        "limit": 200
      }
    ]
  }'