Class Payment
A Payment transaction represents a transfer of value from one account to another.
Inherited Members
Namespace: Xrpl.Models.Transaction
Assembly: Xrpl.dll
Syntax
public class Payment : TransactionCommon, IPayment, ITransactionCommon
Constructors
| Improve this Doc View SourcePayment()
Declaration
public Payment()
Properties
| Improve this Doc View SourceAmount
The amount of currency to deliver.
For non-XRP amounts, the nested field names MUST be lower-case.
If the tfPartialPayment flag is set, deliver up to this amount instead.
Declaration
public Currency Amount { get; set; }
Property Value
Type | Description |
---|---|
Currency |
DeliverMin
Minimum amount of destination currency this transaction should deliver.
Only valid if this is a partial payment.
For non-XRP amounts, the nested field names are lower-case.
Declaration
public Currency DeliverMin { get; set; }
Property Value
Type | Description |
---|---|
Currency |
Destination
The unique address of the account receiving the payment.
Declaration
public string Destination { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DestinationTag
Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay.
Declaration
public uint? DestinationTag { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.UInt32> |
Flags
Payment Transaction Flags
Declaration
public PaymentFlags? Flags { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<PaymentFlags> |
InvoiceID
Arbitrary 256-bit hash representing a specific reason or identifier for this payment.
Declaration
public string InvoiceID { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Paths
Array of payment paths to be used for this transaction.
Must be omitted for XRP-to-XRP transactions.
Declaration
public List<List<Path>> Paths { get; set; }
Property Value
Type | Description |
---|---|
List<List<Path>> |
SendMax
Highest amount of source currency this transaction is allowed to cost, including transfer fees, exchange rates, and slippage.
Does not include the XRP destroyed as a cost for submitting the transaction.
For non-XRP amounts, the nested field names MUST be lower-case.
Must be supplied for cross-currency/cross-issue payments.
Must be omitted for XRP-to-XRP Payments.
Declaration
public Currency SendMax { get; set; }
Property Value
Type | Description |
---|---|
Currency |