EscrowCancel
[Source]
Added by the [Escrow amendment][].
Cancel Using OfferSequence
Section titled “Cancel Using OfferSequence”{ "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "TransactionType": "EscrowCancel", "Owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "OfferSequence": 7,}Cancel Using EscrowID
Section titled “Cancel Using EscrowID”{ "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "TransactionType": "EscrowCancel", "Owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "EscrowID": "49647F0D748DC3FE26BDACBC57F251AADEFFF391403EC9BF87C97F67E9977FB0",}Fields
Section titled “Fields”| Field | JSON Type | Internal Type | Description |
|---|---|---|---|
Owner | String | AccountID | Address of the source account that funded the escrow payment. |
OfferSequence | Number | UInt32 | (Optional) Transaction sequence (or Ticket number) of EscrowCreate transaction that created the escrow to cancel. |
EscrowID | String | Hash256 | (Optional) The ID of the Escrow ledger object to cancel, as a 64-character hexadecimal string. |
Any account may submit an EscrowCancel transaction.
- If the corresponding EscrowCreate transaction did not specify a
CancelAftertime, the EscrowCancel transaction fails. - Otherwise the EscrowCancel transaction fails if the
CancelAftertime is after the close time of the most recently-closed ledger.
Cancellation by the Destination
Section titled “Cancellation by the Destination”(Added by the EscrowDestinationCancel amendment.)
The destination of an escrow may cancel it at any time, returning the funds to the owner. This applies regardless of CancelAfter, and also to escrows that have no CancelAfter.
{ "TransactionType": "EscrowCancel", "Account": "rDestination...", "Owner": "rEscrowOwner...", "OfferSequence": 7}- Self-escrows are excluded. If the owner and the destination are the same account, the normal
CancelAfterrules still apply, so a timelock on your own funds stays binding. - Cancellations submitted by any account other than the destination follow the rules above, and fail with
tecNO_PERMISSIONbeforeCancelAfter(or always, if there is noCancelAfter). - Hooks. When the destination cancels, the escrow owner is only a weak transactional stakeholder, so the owner’s Hooks cannot roll back the cancellation. In all other cases the owner remains a strong transactional stakeholder. See Weak and Strong.