Class PaymentChannelCreateResponse
Create a unidirectional channel and fund it with XRP.
The address sending this transaction becomes the "source address" of the payment channel.
Inheritance
Implements
Inherited Members
Namespace: Xrpl.Models.Transaction
Assembly: Xrpl.dll
Syntax
public class PaymentChannelCreateResponse : TransactionResponseCommon, ITransactionResponseCommon, IBaseTransactionResponse, IPaymentChannelCreate, ITransactionCommon
Properties
| Improve this Doc View SourceAmount
Amount of XRP, in drops, to deduct from the sender's balance and set aside in this channel.
While the channel is open, the XRP can only go to the Destination address.
When the channel closes, any unclaimed XRP is returned to the source address's balance.
Declaration
public string Amount { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CancelAfter
The time, in seconds since the Ripple Epoch, when this channel expires.
Any transaction that would modify the channel after this time closes the channel without otherwise affecting it.
This value is immutable; the channel can be closed earlier than this time but cannot remain open after this time.
Declaration
public DateTime? CancelAfter { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<DateTime> |
Destination
Address to receive XRP claims against this channel.
This is also known as the "destination address" for the channel.
Declaration
public string Destination { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DestinationTag
Arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address.
Declaration
public uint? DestinationTag { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.UInt32> |
PublicKey
The public key of the key pair the source will use to sign claims against this channel in hexadecimal.
This can be any secp256k1 or ed25519 public key.
Declaration
public string PublicKey { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SettleDelay
Amount of time the source address must wait before closing the channel if it has unclaimed XRP.
Declaration
public uint SettleDelay { get; set; }
Property Value
Type | Description |
---|---|
System.UInt32 |
SourceTag
(Optional) Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made.
Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.
Declaration
public uint? SourceTag { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.UInt32> |