Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PaymentChannelCreate

Create a unidirectional channel and fund it with XRP. The address sending this transaction becomes the "source address" of the payment channel.

Hierarchy

  • BaseTransaction
    • PaymentChannelCreate

Index

Properties

Account

Account: string

Optional AccountTxnID

AccountTxnID: string

Amount

Amount: string

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 CancelAfter

CancelAfter: number

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.

Destination

Destination: string

Address to receive XRP claims against this channel. This is also known as. the "destination address" for the channel.

Optional DestinationTag

DestinationTag: number

Arbitrary tag to further specify the destination for this payment channel,. such as a hosted recipient at the destination address.

Optional Fee

Fee: string

Optional Flags

Flags: number | GlobalFlags

Optional LastLedgerSequence

LastLedgerSequence: number

Optional Memos

Memos: { Memo: Memo }[]

PublicKey

PublicKey: string

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 Sequence

Sequence: number

SettleDelay

SettleDelay: number

Amount of time the source address must wait before closing the channel if. it has unclaimed XRP.

Optional Signers

Signers: Signer[]

Optional SigningPubKey

SigningPubKey: string

Optional SourceTag

SourceTag: number

Optional TicketSequence

TicketSequence: number

TransactionType

TransactionType: "PaymentChannelCreate"

Optional TxnSignature

TxnSignature: string

Generated using TypeDoc