taler-docs

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

get-config.rst (1596B)


      1 .. http:get:: /config
      2 
      3   Return the protocol version and currency supported by this service.
      4 
      5   **Response:**
      6 
      7   :http:statuscode:`200 OK`:
      8     The body is a `VersionResponse`.
      9 
     10   **Details:**
     11 
     12   .. ts:def:: VersionResponse
     13 
     14     interface VersionResponse {
     15       // libtool-style representation of the Merchant protocol version, see
     16       // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
     17       // The format is "current:revision:age".
     18       version: string;
     19 
     20       // Name of the protocol.
     21       name: "taler-mailbox";
     22 
     23       // Fixed size of message body.
     24       message_body_bytes: Integer;
     25 
     26       // Maximum number of messages in a
     27       // single response.
     28       message_response_limit: Integer;
     29 
     30       // How long will the service store a message
     31       // before giving up on delivery?
     32       delivery_period: RelativeTime;
     33 
     34       // How much is the cost of a single
     35       // registration (update) of a mailbox
     36       // May be 0 for a free update/registration.
     37       registration_update_fee: Amount
     38 
     39       // How much is the cost of a single
     40       // registration period (30 days) of a mailbox
     41       // May be 0 for a free registration.
     42       monthly_fee: Amount
     43 
     44       // How much is the cost to send a single
     45       // message to a mailbox.
     46       // May be 0 for free message sending.
     47       message_fee: Amount
     48 
     49       // How many messages can be send and
     50       // are stored by the service for free.
     51       // After the quota is reached, the
     52       // regular message_fee applies.
     53       // May be 0 for no free quota.
     54       free_message_quota: Integer
     55 
     56     }