summaryrefslogtreecommitdiff
path: root/core/api-bank-access.rst
diff options
context:
space:
mode:
authorms <ms@taler.net>2022-01-12 19:03:03 +0100
committerms <ms@taler.net>2022-01-12 19:03:03 +0100
commitcba3d9666c9cf50e574370da6f6d79def1c013bc (patch)
treed906ba2dc9f0870e7a8002dc5845ab8323a3b37b /core/api-bank-access.rst
parentf62f09163c9a96c0fc8071375076fafe781291c6 (diff)
downloaddocs-cba3d9666c9cf50e574370da6f6d79def1c013bc.tar.gz
docs-cba3d9666c9cf50e574370da6f6d79def1c013bc.tar.bz2
docs-cba3d9666c9cf50e574370da6f6d79def1c013bc.zip
Sandbox Access API
Diffstat (limited to 'core/api-bank-access.rst')
-rw-r--r--core/api-bank-access.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/core/api-bank-access.rst b/core/api-bank-access.rst
index c1c39feb..3795387f 100644
--- a/core/api-bank-access.rst
+++ b/core/api-bank-access.rst
@@ -30,6 +30,29 @@ to enabling wallets to withdraw with a better user experience ("tight integratio
Accounts and Withdrawals
------------------------
+.. http:get:: ${BANK_API_BASE_URL}/public-accounts
+
+ Show those accounts whose histories are publicly visible. For example,
+ accounts from donation receivers. As such, this request is unauthenticated.
+
+ **Response**
+
+ **Details**
+
+ .. ts:def:: PublicAccountsResponse
+
+ interface PublicAccountsResponse {
+ publicAccounts: PublicAccount[]
+ }
+
+ interface PublicAccount {
+ iban: string;
+ balance: string;
+ // The account name _and_ the username of the
+ // Sandbox customer that owns such a bank account.
+ accountLabel: string;
+ }
+
The following endpoints require HTTP "Basic" authentication with the account
name and account password, at least in the GNU Taler demo bank implementation.