taler-docs

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

get-accounts-USERNAME-cashouts.rst (1248B)

      1 .. http:get:: /accounts/$USERNAME/cashouts
      2 
      3   Returns the list of all cash-out operations for an account.
      4 
      5   **Request:**
      6 
      7   :query limit: *Optional.*
      8     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**.
      9   :query offset: *Optional.*
     10     Starting ``cashout_id`` for :ref:`pagination <row-id-pagination>`. Since **v5**.
     11   :query delta: *Optional.*
     12     Deprecated since **v5**. Use *limit* instead.
     13   :query start: *Optional.*
     14     Deprecated since **v5**. Use *offset* instead.
     15 
     16   **Response:**
     17 
     18   :http:statuscode:`200 OK`:
     19     Response is a `Cashouts`.
     20   :http:statuscode:`204 No Content`:
     21     No cash-out operations were found.
     22   :http:statuscode:`401 Unauthorized`:
     23     Invalid or missing credentials.
     24   :http:statuscode:`403 Forbidden`:
     25     Missing rights.
     26   :http:statuscode:`501 Not implemented`:
     27     This server does not support conversion, client should check config response.
     28 
     29   **Details:**
     30 
     31   .. ts:def:: Cashouts
     32 
     33     interface Cashouts {
     34       // Every string represents a cash-out operation ID.
     35       cashouts: CashoutInfo[];
     36     }
     37 
     38   .. ts:def:: CashoutInfo
     39 
     40     interface CashoutInfo {
     41       cashout_id: Integer;
     42     }