summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2023-03-06 09:21:08 -0300
committerSebastian <sebasjm@gmail.com>2023-03-06 09:21:08 -0300
commit3d5accf0aed02c7e667a98ebd4a375aaae75e848 (patch)
tree00fe33e22a22c90873b4ab7df5a309bc5381f327
parent847d2758a121c1646f0cfbf934d4720b4b10aead (diff)
downloaddocs-3d5accf0aed02c7e667a98ebd4a375aaae75e848.tar.gz
docs-3d5accf0aed02c7e667a98ebd4a375aaae75e848.tar.bz2
docs-3d5accf0aed02c7e667a98ebd4a375aaae75e848.zip
document api change: CircuitAccountMinimalData should include account balance
-rw-r--r--core/api-bank-access.rst10
-rw-r--r--libeufin/api-sandbox.rst28
2 files changed, 23 insertions, 15 deletions
diff --git a/core/api-bank-access.rst b/core/api-bank-access.rst
index 29b397ac..0b01a84e 100644
--- a/core/api-bank-access.rst
+++ b/core/api-bank-access.rst
@@ -70,12 +70,14 @@ name and account password, at least in the GNU Taler demo bank implementation.
.. ts:def:: BankAccountBalanceResponse
+ interface Balance {
+ amount: Amount;
+ credit_debit_indicator: "credit" | "debit";
+ }
+
interface BankAccountBalanceResponse {
// Available balance on the account.
- balance: {
- amount: Amount;
- credit_debit_indicator: "credit" | "debit";
- };
+ balance: Balance;
// payto://-URI of the account. (New)
paytoUri: string;
}
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index 94cc0c8c..05ae3a10 100644
--- a/libeufin/api-sandbox.rst
+++ b/libeufin/api-sandbox.rst
@@ -232,20 +232,26 @@ Accounts
.. ts:def:: CircuitAccounts
- interfaces CircuitAccounts {
- customers: CircuitAccountMinimalData[];
- }
+ interfaces CircuitAccounts {
+ customers: CircuitAccountMinimalData[];
+ }
.. ts:def:: CircuitAccountMinimalData
- interface CircuitAccountMinimalData {
- // Username
- username: string;
-
- // Legal subject owning the account.
- name: string;
-
- }
+ interface Balance {
+ amount: Amount;
+ credit_debit_indicator: "credit" | "debit";
+ }
+ interface CircuitAccountMinimalData {
+ // Username
+ username: string;
+
+ // Legal subject owning the account.
+ name: string;
+
+ // current balance of the account
+ balance: Balance;
+ }
:http:statuscode:`200 OK`:
At least one account was found.