Last updated
Edit

EscrowCancel

[Source]

Return funds from an expired escrow to its sender.

Example EscrowCancel JSON

{
    "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
    "TransactionType": "EscrowCancel",
    "Owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
    "OfferSequence": 7,
}
Query example transaction

EscrowCancel Fields

In addition to the common fields, EscrowCancel transactions use the following fields:

FieldJSON TypeInternal TypeDescription
OwnerString - AddressAccountIDThe account that funded the escrow payment.
OfferSequenceNumberUInt32Transaction sequence (or Ticket number) of EscrowCreate transaction that created the escrow to cancel.

Any account may submit an EscrowCancel transaction.

  • If the corresponding EscrowCreate transaction did not specify a CancelAfter time, the EscrowCancel transaction fails.
  • Otherwise the EscrowCancel transaction fails if the CancelAfter time is after the close time of the most recently-closed ledger.

Error Cases

Besides errors that can occur for all transactions, EscrowCancel transactions can result in the following transaction result codes:

Error CodeDescription
tecNO_AUTHThe transaction failed because authorization requirements were not met. For example, the issuer requires authorization and the sender is not authorized.
tecNO_LINEThe sender does not have a trust line with the issuer. For Trust Line Tokens only.
tecNO_ENTRYThe sender does not hold the MPT.
tecINSUFFICIENT_RESERVEUnable to create a trust line or MPToken due to lack of reserves.

See Also