[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: Add proposal for wallet balances API
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: Add proposal for wallet balances API |
Date: |
Thu, 14 May 2020 21:29:00 +0200 |
This is an automated email from the git hooks/post-receive script.
torsten-grote pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new 7b26800 Add proposal for wallet balances API
7b26800 is described below
commit 7b26800e473211ca8e8682b60f3f38e2a70e6e60
Author: Torsten Grote <address@hidden>
AuthorDate: Thu May 14 16:28:44 2020 -0300
Add proposal for wallet balances API
---
taler-wallet.rst | 41 ++++++++++++++++++++++++++++++++++++++++-
1 file changed, 40 insertions(+), 1 deletion(-)
diff --git a/taler-wallet.rst b/taler-wallet.rst
index e7351fd..1c27d82 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -81,12 +81,51 @@ APIs and Data Formats
These APIs are still a work in progress and *not* final.
+Balances
+--------
+
+Balances are the amounts of digital cash held by the wallet.
+
+:name: ``"getBalances"``
+:description: Get a list of balances per currency.
+:response:
+ .. ts:def:: BalancesResponse
+
+ interface BalancesResponse {
+ // a list of balances sorted by currency.
+ // (currencies with shorter names first, then lexically ascending).
+ balances: Balance[];
+ }
+
+ .. ts:def:: Balance
+
+ interface Balance {
+ currency?: string;
+
+ // the total Amount that is currently available to be spent
+ available: Amount;
+
+ // the total incoming amount that will be added to the available balance
+ // when all pending transactions succeed
+ pendingIncoming: Amount;
+
+ // the total outgoing amount that will be subtracted from the available
balance
+ // when all pending transactions succeed
+ pendingOutgoing: Amount;
+
+ // true if the balance has pending transactions
+ hasPendingTransactions: boolean;
+
+ // true if the balance requires user-interaction, e.g. accepting a tip
+ requiresUserInput: boolean;
+ }
+
Transactions
------------
Transactions are all operations or events that are affecting the balance.
-:name: ``"transactions"``
+:name: ``"getTransactions"``
:description: Get a list of past and pending transactions.
:request:
.. ts:def:: TransactionsRequest
--
To stop receiving notification emails like this one, please contact
address@hidden.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: Add proposal for wallet balances API,
gnunet <=