summaryrefslogtreecommitdiff
path: root/core/api-bank-access.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-02-17 20:49:57 +0100
committerFlorian Dold <florian.dold@gmail.com>2020-02-17 20:49:57 +0100
commit5d1aa42f0a6b48b6e1c2ac8cbefeb3e0b99c1fa2 (patch)
tree75e704034af721c3e82ad92b6a1f7bac7e548ebe /core/api-bank-access.rst
parent0e650e78865fef95adc61021dabce4f294c83ad4 (diff)
downloaddocs-5d1aa42f0a6b48b6e1c2ac8cbefeb3e0b99c1fa2.tar.gz
docs-5d1aa42f0a6b48b6e1c2ac8cbefeb3e0b99c1fa2.tar.bz2
docs-5d1aa42f0a6b48b6e1c2ac8cbefeb3e0b99c1fa2.zip
registration API
Diffstat (limited to 'core/api-bank-access.rst')
-rw-r--r--core/api-bank-access.rst37
1 files changed, 34 insertions, 3 deletions
diff --git a/core/api-bank-access.rst b/core/api-bank-access.rst
index 757a2e3..79d866c 100644
--- a/core/api-bank-access.rst
+++ b/core/api-bank-access.rst
@@ -16,9 +16,9 @@
@author Florian Dold
-=============================
-Taler Bank Account Access API
-=============================
+=====================
+Taler Bank Access API
+=====================
This chapter describes the API that the GNU Taler demonstrator bank offers to access accounts.
@@ -26,6 +26,11 @@ This API differes from the "Bank Integration API" in that it provides advanced A
to enabling wallets to withdraw with an better user experience ("tight integration").
+------------------------
+Accounts and Withdrawals
+------------------------
+
+
.. http:get:: ${BANK_API_BASE_URL}/accounts/${account_name}/balance
Request the current balance of an account.
@@ -141,3 +146,29 @@ to enabling wallets to withdraw with an better user experience ("tight integrati
:status 409 Conflict: The reserve operation has been aborted previously and can't be confirmed.
+
+
+----------------------
+Registration (Testing)
+----------------------
+
+
+.. http:POST:: ${BANK_API_BASE_URL}/testing/register
+
+ Create a new bank account. This endpoint should be disabled for most deployments, but is useful
+ for automated testing / integration tests.
+
+ **Request**
+
+ .. ts:def:: BankRegistrationRequest
+
+ interface BankRegistrationRequest {
+ username: string;
+
+ password: string;
+ }
+
+
+ **Response**
+
+ :status 200 OK: Registration was successful