taler-docs

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

get-config.rst (1002B)

      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     The exchange responds with a `IntegrationConfig` object. This request should
      9     virtually always be successful.
     10 
     11   **Details:**
     12 
     13   .. ts:def:: IntegrationConfig
     14 
     15     interface IntegrationConfig {
     16       // Name of the API.
     17       name: "taler-bank-integration";
     18 
     19       // libtool-style representation of the Bank protocol version, see
     20       // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
     21       //
     22       // The format is "current:revision:age".
     23       version: string;
     24 
     25       // URN of the implementation (needed to interpret 'revision' in version).
     26       // @since **v2**, may become mandatory in the future.
     27       implementation?: string;
     28 
     29       // Currency used by this bank.
     30       currency: string;
     31 
     32       // How the bank SPA should render this currency.
     33       currency_specification: CurrencySpecification;
     34     }