Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountChannelsRequest

The account_channels method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. (A channel's "source" and "owner" are the same.) All information retrieved is relative to a particular version of the ledger. Returns an AccountChannelsResponse.

Hierarchy

  • BaseRequest
    • AccountChannelsRequest

Index

Properties

account: string

The unique identifier of an account, typically the account's address. The request returns channels where this account is the channel's owner/source.

api_version?: number

The API version to use. If omitted, use version 1.

command: "account_channels"
destination_account?: string

The unique identifier of an account, typically the account's address. If provided, filter results to payment channels whose destination is this account.

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

ledger_hash?: string

20-byte hex string for the ledger version to use.

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

limit?: number

Limit the number of transactions to retrieve. Cannot be less than 10 or more than 400. The default is 200.

marker?: unknown

Value from a previous paginated response. Resume retrieving data where that response left off.

Generated using TypeDoc