Files
xrpl-dev-portal/content/transactions/escrowcreate.md
2018-01-16 16:14:15 -08:00

2.5 KiB

EscrowCreate

[Source]

Requires the Escrow Amendment.

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

Example EscrowCreate:

{
    "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
    "TransactionType": "EscrowCreate",
    "Amount": "10000",
    "Destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
    "CancelAfter": 533257958,
    "FinishAfter": 533171558,
    "Condition": "A0258020E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855810100",
    "DestinationTag": 23480,
    "SourceTag": 11747
}
Field JSON Type [Internal Type][] Description
Amount String Amount Amount of [XRP, in drops][Currency Amount], to deduct from the sender's balance and escrow. Once escrowed, the XRP can either go to the Destination address (after the FinishAfter time) or returned to the sender (after the CancelAfter time).
Destination String AccountID Address to receive escrowed XRP.
CancelAfter Number UInt32 (Optional) 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.
FinishAfter Number UInt32 (Optional) 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.
Condition String VariableLength (Optional) Hex value representing a PREIMAGE-SHA-256 crypto-condition. The funds can only be delivered to the recipient if this condition is fulfilled.
DestinationTag Number UInt32 (Optional) Arbitrary tag to further specify the destination for this escrowed payment, such as a hosted recipient at the destination address.
SourceTag Number UInt32 (Optional) Arbitrary tag to further specify the source for this escrowed payment, such as a hosted sender at the source address.

Either CancelAfter or FinishAfter must be specified. If both are included, the FinishAfter time must precede that of CancelAfter.