Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Payment

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

Hierarchy

  • BaseTransaction
    • Payment

Index

Properties

Account

Account: string

Optional AccountTxnID

AccountTxnID: string

Amount

Amount: Amount

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.

Optional DeliverMin

DeliverMin: Amount

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.

Destination

Destination: string

The unique address of the account receiving the payment.

Optional DestinationTag

DestinationTag: number

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

Optional Fee

Fee: string

Optional Flags

Flags: number | PaymentFlagsInterface

Optional InvoiceID

InvoiceID: string

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

Optional LastLedgerSequence

LastLedgerSequence: number

Optional Memos

Memos: { Memo: Memo }[]

Optional Paths

Paths: Path[]

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

Optional SendMax

SendMax: Amount

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.

Optional Sequence

Sequence: number

Optional Signers

Signers: Signer[]

Optional SigningPubKey

SigningPubKey: string

Optional SourceTag

SourceTag: number

Optional TicketSequence

TicketSequence: number

TransactionType

TransactionType: "Payment"

Optional TxnSignature

TxnSignature: string

Generated using TypeDoc