taler-docs

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

start-refund-query.rst (711B)

      1 .. ts:op:: startRefundQuery
      2 
      3   Start a refund query for an existing payment transaction, referenced
      4   by its transaction identifier.  Only payments that completed
      5   successfully are queried; for payments in any other state, the
      6   request has no effect.
      7 
      8   **Request:**
      9 
     10     The ``args`` must be a `StartRefundQueryRequest` object.
     11 
     12   **Response:**
     13 
     14     On success, the result is an empty object.
     15 
     16   **Side effects:**
     17 
     18     Starts a refund query for an existing payment transaction,
     19     contacting the merchant over the network.
     20 
     21 .. ts:def:: StartRefundQueryRequest
     22 
     23   interface StartRefundQueryRequest {
     24     // Transaction identifier of the payment to query refunds for.
     25     transactionId: TransactionIdStr;
     26   }