diff options
author | Florian Dold <florian.dold@gmail.com> | 2020-09-03 23:23:27 +0530 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2020-09-03 23:23:38 +0530 |
commit | 81b4ec7f342e77a3306024d50f5ceee5ee89c50b (patch) | |
tree | 3c62a280531dec19f1ddbb72a407dc9d5e474d74 /taler-wallet.rst | |
parent | b26e3b2e0d2a0e15e61c8b42c9a81d986c1803da (diff) | |
download | docs-81b4ec7f342e77a3306024d50f5ceee5ee89c50b.tar.gz docs-81b4ec7f342e77a3306024d50f5ceee5ee89c50b.tar.bz2 docs-81b4ec7f342e77a3306024d50f5ceee5ee89c50b.zip |
document wallet dumpCoins API
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r-- | taler-wallet.rst | 57 |
1 files changed, 57 insertions, 0 deletions
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 ------------- |