Cancel a Check

This tutorial shows how to cancel a Check, which removes the Check entry from the ledger without sending money.

You may want to cancel an incoming Check if you do not want it. You might cancel an outgoing Check if you made a mistake when sending it or if circumstances have changed. If a Check expires, it's also necessary to cancel it to remove it from the ledger so the sender gets their owner reserve back.

Prerequisites

• You should be familiar with the basics of using the xrpl.js client library.
• You need an XRP Ledger account including its secret key. (You can get one on Testnet for free.) See also: XRP Faucets.
• You need the ID of a Check ledger entry that you are either the sender or recipient of. See also: Send a Check.

Source Code

The complete source code for this tutorial is available in the source repository for this website:

Checks sample code

Steps

1. Prepare the CheckCancel transaction

Figure out the values of the CheckCancel transaction fields. The following fields are the bare minimum; everything else is either optional or can be auto-filled when signing:

For example:

    // Prepare the transaction ------------------------------------------------
    const checkcancel = {
        "TransactionType": "CheckCancel",
        "Account": wallet.address,
        "CheckID": check_id
    };

    

2. Submit the CheckCancel transaction

Submit the CheckCancel transaction in the usual way and wait for it to be validated. If the result code is tesSUCCESS and the transaction is in a validated ledger, the transaction is successful. For example:

    // Submit the transaction -------------------------------------------------
    const tx = await client.submitAndWait(
      checkcancel, 
      { autofill: true, 
          wallet: wallet }
    )
    
    

3. Confirm transaction result

If the transaction succeeded, it should have a "TransactionResult": "tesSUCCESS" field in the metadata, and the field "validated": true in the result, indicating that this result is final. For example:

    // Confirm results --------------------------------------------------------
    console.log(`Transaction result: ${JSON.stringify(tx, null, 2)}`)

    if (tx.result.meta.TransactionResult === "tesSUCCESS") {
      // submitAndWait() only returns when the transaction's outcome is final,
      // so you don't also have to check for validated: true.
      console.log("Transaction was successful.")
    }