get-config.rst (1650B)
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 // Fee per message. 24 message_fee: Amount; 25 26 // Fixed size of message body. 27 message_body_bytes: Integer; 28 29 // Maximum number of messages in a 30 // single response. 31 message_response_limit: Integer; 32 33 // How long will the service store a message 34 // before giving up on delivery? 35 delivery_period: RelativeTime; 36 37 // How much is the cost of a single 38 // registration (update) of a mailbox 39 // May be 0 for a free update/registration. 40 registration_update_fee: Amount 41 42 // How much is the cost of a single 43 // registration period (30 days) of a mailbox 44 // May be 0 for a free registration. 45 monthly_fee: Amount 46 47 // How much is the cost to send a single 48 // message to a mailbox. 49 // May be 0 for free message sending. 50 message_fee: Amount 51 52 // How many messages can be send and 53 // are stored by the service for free. 54 // After the quota is reached, the 55 // regular message_fee applies. 56 // May be 0 for no free quota. 57 free_message_quota: Integer 58 59 }