taler-docs

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

abort-transaction.rst (1035B)

      1 .. ts:op:: abortTransaction
      2 
      3   Abort a transaction.
      4 
      5   **Request:**
      6 
      7     The request ``args`` must be an `AbortTransactionRequest` object.
      8 
      9   **Response:**
     10 
     11     On success, the result is an empty object.
     12 
     13   **Side effects:**
     14 
     15     Transitions the transaction into an aborting state and starts
     16     abort processing, which may issue refunds or recover coins
     17     (network activity).
     18 
     19   **Expected errors:**
     20 
     21     The caller can handle the following errors inline:
     22     ``WALLET_TRANSACTION_NOT_FOUND``,
     23     ``WALLET_TRANSACTION_ACTION_UNSUPPORTED``,
     24     ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``.
     25 
     26   **Details:**
     27 
     28     For payment transactions, aborting puts the payment into an
     29     ``aborting`` state, in which the wallet recovers the spent coins
     30     via a refund where possible before the transaction reaches a
     31     final state.  Whether a transaction can currently be aborted is
     32     advertised in its ``txActions``.
     33 
     34 .. ts:def:: AbortTransactionRequest
     35 
     36   interface AbortTransactionRequest {
     37     transactionId: TransactionIdStr;
     38   }