taler-docs

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

get-cashouts.rst (1388B)

      1 .. http:get:: /cashouts
      2 
      3   Returns the list of all cash-out operations for **all** accounts.
      4 
      5   Can only be used by the administrators.
      6 
      7   **Request:**
      8 
      9   :query limit: *Optional.*
     10     At most return the given number of results. Negative for descending by ``cashout_id``, positive for ascending by ``cashout_id``. Defaults to ``-20``. Since **v5**.
     11   :query offset: *Optional.*
     12     Starting ``cashout_id`` for :ref:`pagination <row-id-pagination>`. Since **v5**.
     13   :query delta: *Optional.*
     14     Deprecated since **v5**. Use *limit* instead.
     15   :query start: *Optional.*
     16     Deprecated since **v5**. Use *offset* instead.
     17 
     18   .. note::
     19 
     20     We might want to add a filter in the future to only
     21     query pending cashout operations.
     22 
     23   **Response:**
     24 
     25   :http:statuscode:`200 OK`:
     26     Response is a `GlobalCashouts`.
     27   :http:statuscode:`204 No Content`:
     28     No cash-out operations were found.
     29   :http:statuscode:`401 Unauthorized`:
     30     Invalid or missing credentials.
     31   :http:statuscode:`403 Forbidden`:
     32     Missing rights.
     33   :http:statuscode:`501 Not implemented`:
     34     This server does not support conversion, client should check config response.
     35 
     36   **Details:**
     37 
     38   .. ts:def:: GlobalCashouts
     39 
     40     interface GlobalCashouts {
     41       cashouts: GlobalCashoutInfo[];
     42     }
     43 
     44   .. ts:def:: GlobalCashoutInfo
     45 
     46     interface GlobalCashoutInfo {
     47       cashout_id: Integer;
     48       username: string;
     49     }