EscrowCreate
[Source]
Added by the [Escrow amendment][].
Example
Section titled “Example”{ "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "TransactionType": "EscrowCreate", "Amount" : { "currency" : "USD", "value" : "1", "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" }, "Destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW", "CancelAfter": 533257958, "FinishAfter": 533171558, "Condition": "A0258020E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855810100", "DestinationTag": 23480, "SourceTag": 11747}
Fields
Section titled “Fields”Field | JSON Type | [Internal Type][] | Description |
---|---|---|---|
Amount | Currency Amount | Amount | Amount to deduct from the sender’s balance and escrow. Once escrowed, the Amount 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 Amount. |
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 to the sender after this time. |
FinishAfter | Number | UInt32 | (Optional) The time, in [seconds since the Ripple Epoch][], when the escrowed Amount can be released to the recipient. This value is immutable; the funds cannot move until this time is reached. |
Condition | String | Blob | (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. |
Either CancelAfter
or FinishAfter
must be specified. If both are included, the FinishAfter
time must be before the CancelAfter
time.
With the [fix1571 amendment][] enabled, you must supply FinishAfter
, Condition
, or both. [New in: rippled 1.0.0][]