taler-docs

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

get-config.rst (1192B)

      1 .. http:get:: /config
      2 
      3   Return the protocol version and configuration information about the adapter.
      4   This specification corresponds to ``current`` protocol being version **1**.
      5 
      6   **Response:**
      7 
      8   :http:statuscode:`200 OK`:
      9     The adapter responds with a `PreparedTransferConfig` object. This request 
     10     should virtually always be successful.
     11 
     12   **Details:**
     13 
     14   .. ts:def:: SubjectFormat
     15 
     16     type SubjectFormat =
     17       | "SIMPLE"
     18       | "URI"
     19       | "CH_QR_BILL";
     20 
     21   .. ts:def:: PreparedTransferConfig
     22 
     23     interface PreparedTransferConfig {
     24       // Name of the API.
     25       name: "taler-prepared-transfer";
     26 
     27       // libtool-style representation of the protocol version, see
     28       // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
     29       // The format is "current:revision:age".
     30       version: string;
     31 
     32       // Currency used by this API.
     33       currency: string;
     34 
     35       // URN of the implementation (needed to interpret 'revision' in version).
     36       // @since v0, may become mandatory in the future.
     37       implementation?: string;
     38 
     39       // Supported formats for registration, there must at least one.
     40       supported_formats: SubjectFormat[];
     41     }