summaryrefslogtreecommitdiff
path: root/core/api-merchant.rst
diff options
context:
space:
mode:
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r--core/api-merchant.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index b9dac41..e60ea8b 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -25,6 +25,22 @@ Merchant Backend API
.. contents:: Table of Contents
+
+--------------------
+Compatibility Checks
+--------------------
+
+.. http:get:: /config
+
+ Return the protocol version and currency supported by this merchant backend.
+ This endpoint is deprecated, clients should migrate to the (identical)
+ /public/version API.
+
+ **Response:**
+
+ :status 200 OK:
+ The exchange accepted all of the coins. The body is a `VersionResponse`.
+
------------------
Receiving Payments
------------------
@@ -973,6 +989,27 @@ The ``/public/*`` endpoints are publicly exposed on the internet and accessed
both by the user's browser and their wallet.
+.. http:get:: /public/config
+
+ Return the protocol version and currency supported by this merchant backend.
+
+ **Response:**
+
+ :status 200 OK:
+ The exchange accepted all of the coins. The body is a `VersionResponse`.
+
+ .. ts:def:: VersionResponse
+
+ interface VersionResponse {
+ // libtool-style representation of the Merchant protocol version, see
+ // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
+ // The format is "current:revision:age".
+ version: string;
+
+ // Currency supported by this backend.
+ currency: string;
+ }
+
.. http:post:: /public/pay
Pay for a proposal by giving a deposit permission for coins. Typically used by