get-config.rst (2784B)
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 **v12**. 5 6 **Response:** 7 8 :http:statuscode:`200 OK`: 9 Response is a `Config`. 10 11 **Details:** 12 13 .. ts:def:: Config 14 15 interface Config { 16 // Name of the API. 17 name: "taler-corebank"; 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 // The format is "current:revision:age". 22 version: string; 23 24 // Bank display name to be used in user interfaces. 25 // For consistency use "Taler Bank" if missing. 26 // @since **v4**, will become mandatory in the next version. 27 bank_name?: string; 28 29 // Advertised base URL to use when you sharing an URL with another 30 // program. 31 // @since **v4**. 32 base_url?: string; 33 34 // If 'true' the server provides local currency conversion support 35 // If 'false' some parts of the API are not supported and return 501 36 allow_conversion: boolean; 37 38 // If 'true' anyone can register 39 // If 'false' only admin can 40 allow_registrations: boolean; 41 42 // If 'true' account can delete themselves 43 // If 'false' only admin can delete accounts 44 allow_deletions: boolean; 45 46 // If 'true' anyone can edit their name 47 // If 'false' only admin can 48 allow_edit_name: boolean; 49 50 // If 'true' anyone can edit their cashout account 51 // If 'false' only admin can 52 allow_edit_cashout_payto_uri: boolean; 53 54 // Default debt limit for newly created accounts 55 default_debit_threshold: Amount; 56 57 // Currency used by this bank. 58 currency: string; 59 60 // How the bank SPA should render this currency. 61 currency_specification: CurrencySpecification; 62 63 // TAN channels supported by the server 64 supported_tan_channels: TanChannel[]; 65 66 // Wire transfer type supported by the bank. 67 // Defaults to 'iban' is missing 68 // @since **v4**, will become mandatory in the next version. 69 wire_type?: string; 70 71 // Wire transfer execution fees. Only applies to bank transactions and withdrawals. 72 // @since **v4**, will become mandatory in the next version. 73 wire_transfer_fees?: Amount; 74 75 // Minimum wire transfer amount allowed. Only applies to bank transactions and withdrawals. 76 // @since **v4**, will become mandatory in the next version. 77 min_wire_transfer_amount?: Amount; 78 79 // Maximum wire transfer amount allowed. Only applies to bank transactions and withdrawals. 80 // @since **v4**, will become mandatory in the next version. 81 max_wire_transfer_amount?: Amount; 82 }