taler-docs

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

get-config.rst (1061B)

      1 .. http:get:: /config
      2 
      3   Return the protocol version and configuration information about the bank.
      4   This specification corresponds to ``current`` protocol being version **5**.
      5 
      6   **Response:**
      7 
      8   :http:statuscode:`200 OK`:
      9     The adapter responds with a `WireConfig` object. This request should
     10     virtually always be successful.
     11 
     12   **Details:**
     13 
     14   .. ts:def:: WireConfig
     15 
     16     interface WireConfig {
     17       // Name of the API.
     18       name: "taler-wire-gateway";
     19 
     20       // libtool-style representation of the Bank protocol version, see
     21       // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
     22       // The format is "current:revision:age".
     23       version: string;
     24 
     25       // Currency used by this gateway.
     26       currency: string;
     27 
     28       // URN of the implementation (needed to interpret 'revision' in version).
     29       // @since v0, may become mandatory in the future.
     30       implementation?: string;
     31 
     32       // Whether implementation support account existence check
     33       // @since **v4**
     34       support_account_check: boolean;
     35     }