Class ChannelAuthorizeRequest

The channel_authorize method creates a signature that can be used to redeem a specific amount of XRP from a payment channel.
The request must specify exactly one of secret, seed, seed_hex, or passphrase. *** Warning: Do not send secret keys to untrusted servers or through unsecured network connections. ***
(This includes the secret, seed, seed_hex, or passphrase fields of this request.))
You should only use this method on a secure, encrypted network connection to a server you run or fully trust with your funds.
Otherwise, eavesdroppers could use your secret key to sign claims and take all the money from this payment channel and anything else using the same key pair.
See Set Up Secure Signing for instructions.

Inheritance
System.Object
RippleRequest
ChannelAuthorizeRequest
Inherited Members
Namespace: Xrpl.Models.Methods
Assembly: Xrpl.dll
Syntax
public class ChannelAuthorizeRequest : RippleRequest

Constructors

| Improve this Doc View Source

ChannelAuthorizeRequest()

Declaration
public ChannelAuthorizeRequest()

Properties

| Improve this Doc View Source

Amount

Cumulative amount of XRP, in drops, to authorize.
If the destination has already received a lesser amount of XRP from this channel, the signature created by this method can be redeemed for the difference.

Declaration
public ulong Amount { get; set; }
Property Value
Type Description
System.UInt64
| Improve this Doc View Source

ChannelId

The unique ID of the payment channel to use.

Declaration
public string ChannelId { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

KeyType

*** Do not send your secret to a server that you do not control or do not trust. ***
(Optional) The signing algorithm of the cryptographic key pair provided.
Valid types are secp256k1 or ed25519.
The default is secp256k1.

Declaration
public string KeyType { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Passphrase

*** Do not send your secret to a server that you do not control or do not trust. ***
(Optional) A string passphrase to use to sign the claim.
This must be the same key pair as the public key specified in the channel.
The key derived from this passphrase must match the public key specified in the channel.
If provided, you must also specify the key_type.
Cannot be used with secret, seed, or seed_hex.

Declaration
public string Passphrase { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RippleAmount

Declaration
public double RippleAmount { get; set; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

Secret

*** Do not send your secret to a server that you do not control or do not trust. ***
(Optional) The secret key to use to sign the claim.
This must be the same key pair as the public key specified in the channel.
Cannot be used with seed, seed_hex, or passphrase.

Declaration
public string Secret { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Seed

*** Do not send your secret to a server that you do not control or do not trust. ***
(Optional) The secret seed to use to sign the claim.
This must be the same key pair as the public key specified in the channel.
Must be in the XRP Ledger's base58 format.
If provided, you must also specify the key_type.
Cannot be used with secret, seed_hex, or passphrase.

Declaration
public string Seed { get; set; }
Property Value
Type Description
System.String