Payment class

Represents a Payment https://xrpl.org/payment.html transaction, which sends value from one account to another. (Depending on the path taken, this can involve additional exchanges of value, which occur atomically.) This transaction type can be used for several types of payments http://xrpl.local/payment.html#types-of-payments. Payments are also the only way to create accounts http://xrpl.local/payment.html#creating-accounts.

Inheritance

Constructors

Payment.new({required CurrencyAmount amount, required String destination, required String account, int? destinationTag, String? invoiceId, List<List<PathStep>>? paths, String? sendMax, String? deliverMin, List<XRPLMemo>? memos = const [], String signingPubKey = "", int? ticketSequance, BigInt? fee, int? lastLedgerSequence, int? sequence, List<XRPLSigners>? signers, dynamic flags, int? sourceTag, List<String> multiSigSigners = const []})
Payment.fromJson(Map<String, dynamic> json)

Properties

account → String
finalinherited
accountTxId → String?
finalinherited
amount → CurrencyAmount
amount The amount of currency to deliver. If the Partial Payment flag is set, deliver up to this amount instead
final
deliverMin → String?
deliverMin Minimum amount of destination currency this transaction should deliver
final
destination → String
destination The address of the account receiving the payment
final
destinationTag → int?
final
fee ↔ BigInt?
getter/setter pairinherited
flags → dynamic
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
invoiceId → String?
invoiceId Arbitrary 256-bit hash representing a specific reason or identifier for this Check.
final
lastLedgerSequence ↔ int?
getter/setter pairinherited
memos ↔ List<XRPLMemo>?
getter/setter pairinherited
multiSigSigners ↔ List<String>
getter/setter pairinherited
networkId ↔ int?
getter/setter pairinherited
paths → List<List<PathStep>>?
paths Array of payment paths to be used (for a cross-currency payment). Must be omitted for XRP-to-XRP transactions.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sendMax → String?
sendMax Maximum amount of source currency this transaction is allowed to cost
final
sequence ↔ int?
getter/setter pairinherited
signers ↔ List<XRPLSigners>?
getter/setter pairinherited
signingPubKey ↔ String
getter/setter pairinherited
sourceTag → int?
finalinherited
ticketSequance → int?
finalinherited
transactionType → XRPLTransactionType
finalinherited
txnSignature ↔ String?
getter/setter pairinherited
validate → String?
no setteroverride

Methods

getHash() → String
inherited
isSigned() → bool
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setFee(BigInt? newFee) → void
inherited
setLastLedgerSequence(int? newSequance) → void
inherited
setMultiSigSignature(List<XRPLSigners> sigs) → void
inherited
setNetworkId(int? network) → void
inherited
setSequence(int? newSequance) → void
inherited
setSignature(String? sig) → void
inherited
toBlob({bool forSigning = true}) → String
inherited
toJson() → Map<String, dynamic>
Converts the object to a JSON representation.
override
toMultisigBlob(String address) → String
inherited
toString() → String
A string representation of this object.
inherited
toXrpl() → Map<String, dynamic>
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited