taler-docs

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

get-reserves-RESERVE_PUB.rst (2130B)

      1 .. http:get:: /reserves/$RESERVE_PUB
      2 
      3   Request summary information about a reserve.
      4 
      5   **Request:**
      6 
      7   :query timeout_ms=MILLISECONDS: *Optional.*  If specified, the exchange will wait up to MILLISECONDS for incoming funds before returning a 404 if the reserve does not yet exist.
      8 
      9   **Response:**
     10 
     11   :http:statuscode:`200 OK`:
     12     The exchange responds with a `ReserveSummary` object; the reserve was known to the exchange.
     13   :http:statuscode:`404 Not found`:
     14     The reserve key does not belong to a reserve known to the exchange.
     15     This response comes with a standard `ErrorDetail` response with
     16     a code of ``TALER_EC_EXCHANGE_GENERIC_RESERVE_UNKNOWN``.
     17   :http:statuscode:`500 Internal Server Error`:
     18     The server experienced an internal error.
     19     This response comes with a standard `ErrorDetail` response.
     20     Possible error codes include
     21     ``TALER_EC_GENERIC_DB_FETCH_FAILED`` or
     22     ``TALER_EC_GENERIC_DB_SOFT_FAILURE``.
     23 
     24   **Details:**
     25 
     26   .. ts:def:: ReserveSummary
     27 
     28     interface ReserveSummary {
     29       // Balance left in the reserve.
     30       balance: Amount;
     31 
     32       // Full payto URI of the bank account that
     33       // (most recently) funded this reserve.
     34       // Useful as a hint for deposit operations for wallets.
     35       // Missing if this reserve was only filled via P2P merges.
     36       // @since protocol **v23**.
     37       last_origin?: string;
     38 
     39       // The expiration date of the reserve.
     40       // Any residual value of in the reserve after this date
     41       // will be returned to the ``last_origin``, if present.
     42       // @since protocol **vRECOUP**.
     43       reserve_expiration: Timestamp;
     44 
     45       // If set, proof of age restriction is required and age restriction needs
     46       // to be set for each coin to this value during the withdrawal from this reserve.
     47       // The client then MUST use a denomination with support for age restriction enabled
     48       // for the withdrawal and MUST set an appropriate value for ``max_age``
     49       // The value represents a valid age group from the list of permissible
     50       // age groups as defined by the exchange's output to /keys.
     51       maximum_age_group?: Integer;
     52     }