xrpl
    Preparing search index...

    Interface AccountChannelsResponse

    The expected response from an AccountChannelsRequest.

    interface AccountChannelsResponse {
        api_version?: number;
        forwarded?: boolean;
        id: string | number;
        result: {
            account: string;
            channels: Channel[];
            ledger_hash: string;
            ledger_index: number;
            limit?: number;
            marker?: unknown;
            validated?: boolean;
        };
        status?: string;
        type: string;
        warning?: "load";
        warnings?: ResponseWarning[];
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    api_version?: number
    forwarded?: boolean
    id: string | number
    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.

    • Optionallimit?: number

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

    • Optionalmarker?: 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.

    • Optionalvalidated?: boolean

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

    status?: string
    type: string
    warning?: "load"
    warnings?: ResponseWarning[]

    Settings

    Member Visibility

    On This Page

    Properties