taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

delete-transaction.rst (847B)

      1 .. ts:op:: deleteTransaction
      2 
      3   Permanently delete a transaction from the wallet's transaction
      4   history.
      5 
      6   **Request:**
      7 
      8     The request ``args`` must be a `DeleteTransactionRequest` object.
      9 
     10   **Response:**
     11 
     12     On success, the result is an empty object.
     13 
     14   **Side effects:**
     15 
     16     Deletes the transaction from the wallet's history.
     17 
     18   **Expected errors:**
     19 
     20     The caller can handle the following errors inline:
     21     ``WALLET_TRANSACTION_NOT_FOUND``,
     22     ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``.
     23 
     24   **Details:**
     25 
     26     Deleting is only possible in states that advertise the ``delete``
     27     action (in ``txActions``), typically final or dialog states.  Any
     28     background task associated with the transaction is stopped.
     29 
     30 .. ts:def:: DeleteTransactionRequest
     31 
     32   interface DeleteTransactionRequest {
     33     transactionId: TransactionIdStr;
     34   }