summaryrefslogtreecommitdiff
path: root/taler-wallet.rst
diff options
context:
space:
mode:
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r--taler-wallet.rst57
1 files changed, 57 insertions, 0 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst
index 7f0f7db..7c77e6e 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
-------------