From 81b4ec7f342e77a3306024d50f5ceee5ee89c50b Mon Sep 17 00:00:00 2001
From: Florian Dold <florian.dold@gmail.com>
Date: Thu, 3 Sep 2020 23:23:27 +0530
Subject: document wallet dumpCoins API

---
 taler-wallet.rst | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

(limited to 'taler-wallet.rst')

diff --git a/taler-wallet.rst b/taler-wallet.rst
index 7f0f7dbb..7c77e6e4 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -895,6 +895,63 @@ Make a test payment
       summary: string;
     }
 
+
+Dump all coins to JSON
+~~~~~~~~~~~~~~~~~~~~~~
+
+:Name: ``"dumpCoins"``
+:Description:
+  Make a test payment with existing funds.
+:Request:
+  The request object is ignored.
+:Response:
+  .. code:: ts
+
+    interface CoinDumpJson {
+      coins: Array<{
+        /**
+         * The coin's denomination's public key.
+         */
+        denom_pub: string;
+        /**
+         * Hash of denom_pub.
+         */
+        denom_pub_hash: string;
+        /**
+         * Value of the denomination (without any fees).
+         */
+        denom_value: string;
+        /**
+         * Public key of the coin.
+         */
+        coin_pub: string;
+        /**
+         * Base URL of the exchange for the coin.
+         */
+        exchange_base_url: string;
+        /**
+         * Remaining value on the coin, to the knowledge of
+         * the wallet.
+         */
+        remaining_value: string;
+        /**
+         * Public key of the parent coin.
+         * Only present if this coin was obtained via refreshing.
+         */
+        refresh_parent_coin_pub: string | undefined;
+        /**
+         * Public key of the reserve for this coin.
+         * Only present if this coin was obtained via refreshing.
+         */
+        withdrawal_reserve_pub: string | undefined;
+        /**
+         * Is the coin suspended?
+         * Suspended coins are not considered for payments.
+         */
+        coin_suspended: boolean;
+      }>;
+    }
+
 Global Errors
 -------------
 
-- 
cgit v1.2.3