Interface IPayment

A Payment transaction represents a transfer of value from one account to another.

Inherited Members
Namespace: Xrpl.Models.Transactions
Assembly: Xrpl.dll
Syntax
public interface IPayment : ITransactionCommon, IDestination

Properties

| Edit this page View Source

Amount

API v1 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. Alias to DeliverMax
API v2: The maximum amount of currency to deliver.
Partial payments can deliver less than this amount and still succeed;
other payments fail unless they deliver the exact amount.

Declaration
Currency? Amount { get; set; }
Property Value
Type Description
Currency
| Edit this page View Source

CredentialIDs

(Optional) Set of Credentials (object IDs, hex 64-char each) to authorize a deposit when the destination account requires Deposit Authorization with credential-based preauth (XLS-70). Maximum 8 entries.

Declaration
List<string> CredentialIDs { get; set; }
Property Value
Type Description
List<string>
| Edit this page View Source

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
Currency? DeliverMin { get; set; }
Property Value
Type Description
Currency
| Edit this page View Source

Destination

The unique address of the account receiving the payment.

Declaration
string Destination { get; set; }
Property Value
Type Description
string
| Edit this page View Source

DestinationTag

Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay.

Declaration
uint? DestinationTag { get; set; }
Property Value
Type Description
uint?
| Edit this page View Source

DomainID

The domain the sender intends to use for cross-currency payments through the permissioned DEX. Both sender and destination must be part of this domain if it interacts with the DEX.

Declaration
string DomainID { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Flags

Payment Transaction Flags

Declaration
PaymentFlags? Flags { get; set; }
Property Value
Type Description
PaymentFlags?
| Edit this page View Source

InvoiceID

Arbitrary 256-bit hash representing a specific reason or identifier for this payment.

Declaration
string InvoiceID { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Paths

Array of payment paths to be used for this transaction.
Must be omitted for XRP-to-XRP transactions.

Declaration
List<List<Path>> Paths { get; set; }
Property Value
Type Description
List<List<Path>>
| Edit this page View Source

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
Currency SendMax { get; set; }
Property Value
Type Description
Currency