taler-docs

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

reclaim-payment.rst (793B)

      1 .. ts:op:: reclaimPayment
      2 
      3   Claim an order again for this wallet after it was released for
      4   handoff with :ts:op:`unclaimPayment`.  Claiming again with the same
      5   nonce is idempotent.
      6 
      7   **Request:**
      8 
      9     The ``args`` must be a `ReclaimPaymentRequest` object.
     10 
     11   **Response:**
     12 
     13     On success, the result is an empty object.
     14 
     15   **Side effects:**
     16 
     17     Reclaims a payment previously handed off to another wallet;
     18     changes the transaction state.
     19 
     20   **Expected errors:**
     21 
     22     The caller can handle the following errors inline:
     23     ``WALLET_TRANSACTION_NOT_FOUND``,
     24     ``WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED``.
     25 
     26 .. ts:def:: ReclaimPaymentRequest
     27 
     28   interface ReclaimPaymentRequest {
     29     // Transaction identifier of the payment to claim again.
     30     transactionId: TransactionIdStr;
     31   }