Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PaymentChannelFund

Add additional XRP to an open payment channel, and optionally update the expiration time of the channel. Only the source address of the channel can use this transaction.

Hierarchy

  • BaseTransaction
    • PaymentChannelFund

Index

Properties

Account

Account: string

The unique address of the account that initiated the transaction.

Optional AccountTxnID

AccountTxnID: string

Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

Amount

Amount: string

Amount of XRP in drops to add to the channel. Must be a positive amount of XRP.

Channel

Channel: string

The unique ID of the channel to fund as a 64-character hexadecimal string.

Optional Expiration

Expiration: number

New Expiration time to set for the channel in seconds since the Ripple Epoch. This must be later than either the current time plus the SettleDelay of the channel, or the existing Expiration of the channel. After the Expiration time, any transaction that would access the channel closes the channel without taking its normal action. Any unspent XRP is returned to the source address when the channel closes. (Expiration is separate from the channel's immutable CancelAfter time.) For more information, see the PayChannel ledger object type.

Optional Fee

Fee: string

Integer 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 Flags

Flags: number | GlobalFlags

Set of bit-flags for this transaction.

Optional LastLedgerSequence

LastLedgerSequence: number

Highest 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 Memos

Memos: { Memo: Memo }[]

Additional arbitrary information used to identify this transaction.

Optional Sequence

Sequence: number

The 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.

Optional Signers

Signers: Signer[]

Array of objects that represent a multi-signature which authorizes this transaction.

Optional SigningPubKey

SigningPubKey: string

Hex 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 SourceTag

SourceTag: number

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.

Optional TicketSequence

TicketSequence: number

The 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.

TransactionType

TransactionType: "PaymentChannelFund"

Optional TxnSignature

TxnSignature: string

The signature that verifies this transaction as originating from the account it says it is from.

Generated using TypeDoc