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. Expects an AccountChannelsResponse.

Hierarchy

  • BaseRequest
    • AccountChannelsRequest

Index

Properties

account

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.

Optional api_version

api_version: number

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

command

command: "account_channels"

Optional destination_account

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.

Optional id

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.

Optional ledger_hash

ledger_hash: string

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

Optional ledger_index

ledger_index: LedgerIndex

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

limit

limit: number

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

Optional marker

marker: unknown

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

Generated using TypeDoc