summaryrefslogtreecommitdiff
path: root/core/api-exchange.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2023-02-19 10:19:38 +0100
committerChristian Grothoff <christian@grothoff.org>2023-02-19 10:19:43 +0100
commit5abd7fab6fd15ba11dbc7dbdc263ad63685e7df3 (patch)
tree5fec68244628e72e422cd7449be7af5b0ca7ff9c /core/api-exchange.rst
parent1cb4d5a8b7941b7f53e59d855bcaa490a102fd56 (diff)
downloaddocs-5abd7fab6fd15ba11dbc7dbdc263ad63685e7df3.tar.gz
docs-5abd7fab6fd15ba11dbc7dbdc263ad63685e7df3.tar.bz2
docs-5abd7fab6fd15ba11dbc7dbdc263ad63685e7df3.zip
add /config for exchange
Diffstat (limited to 'core/api-exchange.rst')
-rw-r--r--core/api-exchange.rst31
1 files changed, 30 insertions, 1 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index 6628e8ba..9492e7e5 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -1,6 +1,6 @@
..
This file is part of GNU TALER.
- Copyright (C) 2014-2022 Taler Systems SA
+ Copyright (C) 2014-2023 Taler Systems SA
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License as published by the Free Software
@@ -53,6 +53,35 @@ possibly by using HTTPS.
returned MUST be mixed with locally generated entropy.
+.. http:get:: /config
+
+ Return the protocol version and currency supported by this exchange backend, as well as the list of possible KYC requirements. This endpoint is largely for the SPA for AML officers. Merchants should use ``/keys`` which also contains the protocol version and currency.
+
+ **Response:**
+
+ :http:statuscode:`200 OK`:
+ The body is a `VersionResponse`.
+
+ .. ts:def:: ExchangeVersionResponse
+
+ interface ExchangeVersionResponse {
+ // libtool-style representation of the Exchange protocol version, see
+ // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
+ // The format is "current:revision:age".
+ version: string;
+
+ // Name of the protocol.
+ name: "taler-exchange";
+
+ // Currency supported by this exchange.
+ currency: string;
+
+ // Names of supported KYC requirements.
+ supported_kyc_requirements: string[];
+
+ }
+
+
.. http:get:: /keys
Get a list of all denomination keys offered by the exchange,