Interface AccountChannelsResponse

The expected response from an AccountChannelsRequest.

Hierarchy

Properties

api_version? forwarded? id result status? type warning? warnings?

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: {
    account: string;
    channels: Channel[];
    ledger_hash: string;
    ledger_index: number;
    limit?: number;
    marker?: unknown;
    validated?: boolean;
}

Type declaration

  • account: string

    The address of the source/owner of the payment channels. This corresponds to the account field of the request.

  • channels: Channel[]

    Payment channels owned by this account.

  • ledger_hash: string

    The identifying hash of the ledger version used to generate this response.

  • ledger_index: number

    The ledger index of the ledger version used to generate this response.

  • Optional limit?: number

    The limit to how many channel objects were actually returned by this request.

  • Optional marker?: unknown

    Server-defined value for pagination. Pass this to the next call to resume getting results where this call left off. Omitted when there are no additional pages after this one.

  • Optional validated?: boolean

    If true, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change.

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: ResponseWarning[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc