taler-docs

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

get-rate.rst (819B)


      1 .. http:get:: /rate
      2 
      3   Since protocol **v2**.
      4 
      5   This public endpoint allows clients to get the currenlty applied change rate between the regional currency and the fiat currency of the banking system for this exchange account.
      6   Those informations should never be used to perform conversions use ``/cashin-rate`` and ``/cashout-rate`` instead.
      7   Conversion rates can change at any time. Clients must deal with any resulting errors and call ``/cashin-rate`` or ``/cashout-rate`` again to use the new rates.
      8   If ``cashin_ratio`` is zero, this means the account cannot cashin, and if ``cash_out`` ratio is zero, this means the account cannot cashout.
      9 
     10   **Response:**
     11 
     12   :http:statuscode:`200 OK`:
     13     Response is a `ConversionRate`.
     14   :http:statuscode:`501 Not implemented`:
     15     This server does not support conversion.