The unique address of the transaction sender.
Optional
AccountHash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.
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.
Optional
CancelThe 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.
Address to receive XRP claims against this channel. This is also known as the "destination address" for the channel.
Optional
DestinationArbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address.
Optional
FeeInteger amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.
Optional
FlagsSet of bit-flags for this transaction.
Optional
LastHighest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.
Optional
MemosAdditional arbitrary information used to identify this transaction.
Optional
NetworkIDThe network id of the transaction.
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.
Optional
SequenceThe sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.
Amount of time the source address must wait before closing the channel if it has unclaimed XRP.
Optional
SignersArray of objects that represent a multi-signature which authorizes this transaction.
Optional
SigningHex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.
Optional
SourceArbitrary 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.
Optional
TicketThe sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
The type of transaction. Valid types include: Payment
, OfferCreate
,
TrustSet
, and many others.
Optional
TxnThe signature that verifies this transaction as originating from the account it says it is from.
Generated using TypeDoc
Create a unidirectional channel and fund it with XRP. The address sending this transaction becomes the "source address" of the payment channel.