taler-docs

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

start-refund-query-for-uri.rst (1213B)

      1 .. ts:op:: startRefundQueryForUri
      2 
      3   Check for a refund based on a ``taler://refund`` URI.
      4 
      5   Locates the payment for the order identified by the URI and starts a
      6   refund query on it; the refund processing then continues as part of
      7   the payment transaction.  The ``WALLET_PURCHASE_NOT_FOUND`` error is
      8   returned when the wallet has no purchase for the order, for example
      9   because it was paid with a different wallet.
     10 
     11   **Request:**
     12 
     13     The ``args`` must be a `PrepareRefundRequest` object.
     14 
     15   **Response:**
     16 
     17     On success, the result is a `StartRefundQueryForUriResponse`
     18     object.
     19 
     20   **Side effects:**
     21 
     22     Creates or updates a refund query and contacts the merchant over
     23     the network.
     24 
     25   **Expected errors:**
     26 
     27     The caller can handle the following errors inline:
     28     ``WALLET_TALER_URI_MALFORMED``, ``WALLET_PURCHASE_NOT_FOUND``.
     29 
     30 .. ts:def:: PrepareRefundRequest
     31 
     32   interface PrepareRefundRequest {
     33     // The taler://refund URI to check for refunds.
     34     talerRefundUri: string;
     35   }
     36 
     37 .. ts:def:: StartRefundQueryForUriResponse
     38 
     39   interface StartRefundQueryForUriResponse {
     40     // Transaction id of the *payment* where the refund query
     41     // was started.
     42     transactionId: TransactionIdStr;
     43   }