xrpl
    Preparing search index...

    Interface ChannelVerifyRequest

    The channel_verify method checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel. Expects a response in the form of a ChannelVerifyResponse.

    interface ChannelVerifyRequest {
        amount: string;
        api_version?: number;
        channel_id: string;
        command: "channel_verify";
        id?: string | number;
        public_key: string;
        signature: string;
        [x: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [x: string]: unknown
    Index

    Properties

    amount api_version? channel_id command id? public_key signature

    Properties

    amount: string

    The amount of XRP, in drops, the provided signature authorizes.

    api_version?: number

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

    channel_id: string

    The Channel ID of the channel that provides the XRP. This is a 64-character hexadecimal string.

    command: "channel_verify"

    The name of the API method.

    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.

    public_key: string

    The public key of the channel and the key pair that was used to create the signature, in hexadecimal or the XRP Ledger's base58 format.

    signature: string

    The signature to verify, in hexadecimal.

    Settings

    Member Visibility

    On This Page

    Properties