get-reserves-RESERVE_PUB.rst (1724B)
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 16 **Details:** 17 18 .. ts:def:: ReserveSummary 19 20 interface ReserveSummary { 21 // Balance left in the reserve. 22 balance: Amount; 23 24 // Full payto URI of the bank account that 25 // (most recently) funded this reserve. 26 // Useful as a hint for deposit operations for wallets. 27 // Missing if this reserve was only filled via P2P merges. 28 // @since protocol **v23**. 29 last_origin?: string; 30 31 // The expiration date of the reserve. 32 // Any residual value of in the reserve after this date 33 // will be returned to the ``last_origin``, if present. 34 // @since protocol **vRECOUP**. 35 reserve_expiration: Timestamp; 36 37 // If set, proof of age restriction is required and age restriction needs 38 // to be set for each coin to this value during the withdrawal from this reserve. 39 // The client then MUST use a denomination with support for age restriction enabled 40 // for the withdrawal and MUST set an appropriate value for ``max_age`` 41 // The value represents a valid age group from the list of permissible 42 // age groups as defined by the exchange's output to /keys. 43 maximum_age_group?: Integer; 44 }