Interface IEscrowCreate

Sequester XRP or fungible tokens (IOUs, MPTs) until the escrow process either finishes or is canceled. Requires the TokenEscrow amendment for fungible token support.

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

Properties

| Edit this page View Source

Amount

The amount to deduct from the sender's balance and set aside in escrow. Can be XRP (in drops, as a string), an IOU token, or an MPT. Must always be a positive value. With the TokenEscrow amendment, this field supports fungible tokens in addition to XRP.

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

CancelAfter

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.

Declaration
DateTime? CancelAfter { get; set; }
Property Value
Type Description
Nullable
| Edit this page View Source

Condition

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

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

Destination

Address to receive escrowed funds.

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

DestinationTag

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

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

FinishAfter

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.

Declaration
DateTime? FinishAfter { get; set; }
Property Value
Type Description
Nullable