xrpl
    Preparing search index...

    Interface Payment

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

    interface Payment {
        Account: string;
        AccountTxnID?: string;
        Amount: MPTAmount | Amount;
        CredentialIDs?: string[];
        Delegate?: string;
        DeliverMax?: MPTAmount | Amount;
        DeliverMin?: MPTAmount | Amount;
        Destination: string;
        DestinationTag?: number;
        DomainID?: string;
        Fee?: string;
        Flags?: number | PaymentFlagsInterface;
        InvoiceID?: string;
        LastLedgerSequence?: number;
        Memos?: Memo[];
        NetworkID?: number;
        Paths?: Path[];
        SendMax?: MPTAmount | Amount;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        TicketSequence?: number;
        TransactionType: "Payment";
        TxnSignature?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account AccountTxnID? Amount CredentialIDs? Delegate? DeliverMax? DeliverMin? Destination DestinationTag? DomainID? Fee? Flags? InvoiceID? LastLedgerSequence? Memos? NetworkID? Paths? SendMax? Sequence? Signers? SigningPubKey? SourceTag? TicketSequence? TransactionType TxnSignature?

    Properties

    Account: string

    The unique address of the transaction sender.

    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: MPTAmount | 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.

    CredentialIDs?: string[]

    Credentials associated with the sender of this transaction. The credentials included must not be expired.

    Delegate?: string

    The delegate account that is sending the transaction.

    DeliverMax?: MPTAmount | Amount
    DeliverMin?: MPTAmount | 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: string

    The unique address of the account receiving the payment.

    DestinationTag?: number

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

    DomainID?: string

    The domain the sender intends to use. Both the sender and destination must be part of this domain. The DomainID can be included if the sender intends it to be a cross-currency payment (i.e. if the payment is going to interact with the DEX). The domain will only play it's role if there is a path that crossing an orderbook.

    Note: it's still possible that DomainID is included but the payment does not interact with DEX, it simply means that the DomainID will be ignored during payment paths.

    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.

    Flags?: number | PaymentFlagsInterface

    Set of bit-flags for this transaction.

    InvoiceID?: string

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

    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.

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    NetworkID?: number

    The network id of the transaction.

    Paths?: Path[]

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

    SendMax?: MPTAmount | 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.

    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.

    Signers?: Signer[]

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

    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.

    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.

    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: "Payment"

    The type of transaction. Valid types include: Payment, OfferCreate, TrustSet, and many others.

    TxnSignature?: string

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

    Settings

    Member Visibility

    On This Page

    Properties