taler-docs

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

get-config.rst (1448B)

      1 .. http:get:: /config
      2 
      3   Return the protocol version and configuration information about the bank.
      4 
      5   **Response:**
      6 
      7   :http:statuscode:`200 OK`:
      8     Response is a `ConversionConfig`.
      9   :http:statuscode:`501 Not implemented`:
     10     This server does not support conversion, client should check config response.
     11 
     12   **Details:**
     13 
     14   .. ts:def:: ConversionConfig
     15 
     16     interface ConversionConfig {
     17       // libtool-style representation of the Bank protocol version, see
     18       // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
     19       // The format is "current:revision:age".
     20       version: string;
     21 
     22       // Name of the API.
     23       name: "taler-conversion-info";
     24 
     25       // URN of the implementation (needed to interpret 'revision' in version).
     26       // @since v4, may become mandatory in the future.
     27       implementation?: string;
     28 
     29       // Currency used by this bank.
     30       regional_currency: string;
     31 
     32       // How the bank SPA should render this currency.
     33       regional_currency_specification: CurrencySpecification;
     34 
     35       // External currency used during conversion.
     36       fiat_currency: string;
     37 
     38       // How the bank SPA should render this currency.
     39       fiat_currency_specification: CurrencySpecification;
     40 
     41       // Global exchange rate between the regional currency and the fiat
     42       // currency of the banking system. Use /rate to get the user specific
     43       // rate.
     44       conversion_rate: ConversionRate;
     45     }