summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2020-02-04 21:45:32 +0100
committerChristian Grothoff <christian@grothoff.org>2020-02-04 21:45:32 +0100
commit0ec883104a3908049763c25c8b3873d137f65a43 (patch)
tree088200b0aaf1f1b49ecefa0ace4df61a3717c548
parent12a5498a6e749e24f155a3dcda22ec0855eeb193 (diff)
downloaddocs-0ec883104a3908049763c25c8b3873d137f65a43.tar.gz
docs-0ec883104a3908049763c25c8b3873d137f65a43.tar.bz2
docs-0ec883104a3908049763c25c8b3873d137f65a43.zip
specify /config API for bank (#6066)
-rw-r--r--core/api-bank.rst32
1 files changed, 29 insertions, 3 deletions
diff --git a/core/api-bank.rst b/core/api-bank.rst
index 7fc1255b..0b7b9718 100644
--- a/core/api-bank.rst
+++ b/core/api-bank.rst
@@ -1,7 +1,7 @@
..
This file is part of GNU TALER.
- Copyright (C) 2014, 2015, 2016, 2017 Taler Systems SA
+ Copyright (C) 2014-2020 Taler Systems SA
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
@@ -26,6 +26,34 @@ to tightly integrate with GNU Taler.
.. contents:: Table of Contents
+.. http:get:: /config
+
+ Get a configuration information about the bank.
+
+ **Request:**
+
+ **Response:**
+
+ :status 200 OK:
+ The exchange responds with a `BankVersion` object. This request should
+ virtually always be successful.
+
+ **Details:**
+
+ .. ts:def:: BankVersion
+
+ interface BankVersion {
+ // libtool-style representation of the Bank protocol version, see
+ // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
+ // The format is "current:revision:age".
+ version: string;
+
+ // currency used by this bank
+ currency: string;
+
+ }
+
+
-----------
Withdrawing
-----------
@@ -145,5 +173,3 @@ of the wallet's integration tests.
.. http:post:: ${BANK_API_BASE_URL}/testing/withdraw
.. http:post:: ${BANK_API_BASE_URL}/testing/withdraw-uri
-
-