Forget

DELETE /wallets/{walletId}/transactions/{transactionId}

status: stable

Forget pending transaction. Importantly, a transaction, when sent, cannot be cancelled. One can only request forgetting about it in order to try spending (concurrently) the same UTxO in another transaction. But, the transaction may still show up later in a block and therefore, appear in the wallet.

Path parameters

  • walletId string(hex) Required

    Minimum length is 40, maximum length is 40.

  • transactionId string(hex) Required

    Minimum length is 64, maximum length is 64.

Responses

  • 406 application/json

    Not Acceptable

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Accept' header.

    • code string Required

      Value is not_acceptable.
  • 403 application/json

    Forbidden

    Hide response attributes Show response attributes object
    • message string Required

      Occurs when attempting to delete a transaction which is neither pending nor expired.

    • code string Required

      Value is transaction_already_in_ledger.

    • info object

      Additional properties are allowed.

      Hide info attribute Show info attribute object
      • transaction_id string(hex) Required

        A unique identifier for this transaction

        Minimum length is 64, maximum length is 64.
  • 404 application/json

    Not Found

    One of:
    no_such_wallet object wallet_not_initialized object no_such_transaction object
    Hide attributes Show attributes
    • message string Required

      May occur when a given walletId does not match with any known wallets (because it has been deleted, or has never existed).

    • code string Required

      Value is no_such_wallet.

    • info object

      Additional properties are allowed.

      Hide info attribute Show info attribute object
      • wallet_id string(hex) Required

        A unique identifier for the wallet

        Minimum length is 40, maximum length is 40.
  • 204

    No Content

DELETE /wallets/{walletId}/transactions/{transactionId} 
curl \
 --request DELETE 'https://localhost:8090/v2/wallets/{walletId}/transactions/{transactionId}'
Response examples (406) 
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (403) 
{
  "message": "string",
  "code": "transaction_already_in_ledger",
  "info": {
    "transaction_id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1"
  }
}
Response examples (404) 
{
  "message": "string",
  "code": "no_such_wallet",
  "info": {
    "wallet_id": "2512a00e9653fe49a44a5886202e24d77eeb998f"
  }
}
{
  "message": "string",
  "code": "wallet_not_initialized"
}
{
  "message": "string",
  "code": "no_such_transaction",
  "info": {
    "transaction_id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1"
  }
}