taler-docs

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

get-config.rst (3142B)

      1 .. http:get:: /config
      2 
      3   Return the protocol version and currency supported by this exchange backend,
      4   as well as the list of possible KYC requirements.  This endpoint is largely
      5   for the SPA for AML officers. Merchants should use ``/keys`` which also
      6   contains the protocol version and currency.
      7 
      8   **Response:**
      9 
     10   :http:statuscode:`200 OK`:
     11     The body is a `VersionResponse`.
     12 
     13   .. ts:def:: ExchangeVersionResponse
     14 
     15     interface ExchangeVersionResponse {
     16       // libtool-style representation of the Exchange protocol version, see
     17       // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
     18       // The format is "current:revision:age".
     19       version: string;
     20 
     21       // Name of the protocol.
     22       name: "taler-exchange";
     23 
     24       // URN of the implementation (needed to interpret 'revision' in version).
     25       // @since protocol **v18**, may become mandatory in the future.
     26       implementation?: string;
     27 
     28       // Currency supported by this exchange, given
     29       // as a currency code ("USD" or "EUR").
     30       currency: string;
     31 
     32       // Shopping URL where users may find shops that accept
     33       // digital cash issued by this exchange.
     34       // @since protocol **v21**.
     35       shopping_url?: string;
     36 
     37       // How wallets should render this currency.
     38       currency_specification: CurrencySpecification;
     39 
     40       // Names of supported KYC requirements.
     41       // @deprected in **v24**.
     42       supported_kyc_requirements: string[];
     43 
     44       // Bank-specific dialect for the AML SPA. Determines
     45       // which set of forms is available as well as statistics
     46       // to show and sets of properties/events to trigger in
     47       // AML decisions.
     48       // @since protocol **v24**.
     49       aml_spa_dialect?: string;
     50 
     51     }
     52 
     53   .. ts:def:: CurrencySpecification
     54 
     55     interface CurrencySpecification {
     56       // Name of the currency. Like "US Dollar".
     57       name: string;
     58 
     59       // Code of the currency.
     60       // @deprecated in protocol **v18** for the exchange, and
     61       // @deprecated in protocol **v6** for the merchant.
     62       currency: string;
     63 
     64       // how many digits the user may enter after the decimal_separator
     65       num_fractional_input_digits: Integer;
     66 
     67       // Number of fractional digits to render in normal font and size.
     68       num_fractional_normal_digits: Integer;
     69 
     70       // Number of fractional digits to render always, if needed by
     71       // padding with zeros.
     72       num_fractional_trailing_zero_digits: Integer;
     73 
     74       // map of powers of 10 to alternative currency names / symbols, must
     75       // always have an entry under "0" that defines the base name,
     76       // e.g.  "0 => €" or "3 => k€". For BTC, would be "0 => BTC, -3 => mBTC".
     77       // Communicates the currency symbol to be used.
     78       alt_unit_names: { log10 : string };
     79 
     80       // An array of common amounts that should be turned into
     81       // display buttons in dialogs where the user might like
     82       // a short-cut.  The array should have four entries, but
     83       // may have fewer or more entries. Wallets may omit
     84       // later entries in the array.
     85       // @since protocol **v30** (rev 2)
     86       common_amounts: Amount[];
     87 
     88     }