xrpl
    Preparing search index...

    Interface EscrowCreate

    Sequester XRP until the escrow process either finishes or is canceled.

    interface EscrowCreate {
        Account: string;
        AccountTxnID?: string;
        Amount: MPTAmount | Amount;
        CancelAfter?: number;
        Condition?: string;
        Delegate?: string;
        Destination: string;
        DestinationTag?: number;
        Fee?: string;
        FinishAfter?: number;
        Flags?: number | GlobalFlagsInterface;
        LastLedgerSequence?: number;
        Memos?: Memo[];
        NetworkID?: number;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        TicketSequence?: number;
        TransactionType: "EscrowCreate";
        TxnSignature?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account AccountTxnID? Amount CancelAfter? Condition? Delegate? Destination DestinationTag? Fee? FinishAfter? Flags? LastLedgerSequence? Memos? NetworkID? 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 to deduct from the sender's balance and and set aside in escrow. Once escrowed, this amount can either go to the Destination address (after any Finish times/conditions) or returned to the sender (after any cancellation times/conditions). Can represent XRP, in drops, an IOU token, or an MPT. Must always be a positive value.

    CancelAfter?: number

    The time, in seconds since the Ripple Epoch, when this escrow expires. This value is immutable; the funds can only be returned the sender after. this time.

    Condition?: string

    Hex value representing a PREIMAGE-SHA-256 crypto-condition . The funds can. only be delivered to the recipient if this condition is fulfilled.

    Delegate?: string

    The delegate account that is sending the transaction.

    Destination: string

    Address to receive escrowed XRP.

    DestinationTag?: number

    Arbitrary tag to further specify the destination for this escrowed. payment, such as a hosted recipient at the destination address.

    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.

    FinishAfter?: number

    The time, in seconds since the Ripple Epoch, when the escrowed XRP can be released to the recipient. This value is immutable; the funds cannot move. until this time is reached.

    Flags?: number | GlobalFlagsInterface

    Set of bit-flags for this transaction.

    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.

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

    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