commit d7ef2c1e7178bd48aea3111feab7f2ff9e720e2b
parent 1e10decac5fed8eecbb7e89038a33797b6635dae
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 24 Sep 2023 11:51:30 +0200
taler-corebank, not libeufin-bank
Diffstat:
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -16,7 +16,7 @@
.. target audience: developer, core developer
-.. _libeufin-bank-api:
+.. _corebank-api:
====================
Taler Core Bank API
@@ -36,7 +36,7 @@ Authentication
Some requests require the client to authenticate via HTTP Basic auth (RFC 7617)
or using a bearer token which can be obtained or refreshed from the
``/accounts/$USERNAME/token`` endpoint.
-When using Basic authentication, the user-id must be the libeufin-bank
+When using Basic authentication, the user-id must be the bank
username, and the password the password for the corresponding user.
Another way to obtain a login token is by manually configuring it for certain
@@ -51,10 +51,10 @@ client to authenticate as the admin.
See :ref:`DD 48 token endpoint <dd48-token>`.
-Libeufin Bank Web UI
---------------------
+Bank Web UI
+-----------
-The web UI for the libeufin-bank is typically served under ``/``.
+The web UI for the bank is typically served under ``/``.
Config
------
@@ -66,7 +66,7 @@ Config
.. ts:def:: Config
interface Config {
- // Name of this API, always "libeufin-bank".
+ // Name of this API, always "taler-corebank".
name: string;
// API version in the form $n:$n:$n
@@ -88,7 +88,7 @@ Config
Account Management
------------------
-.. _libeufin-bank-account-register:
+.. _bank-account-register:
.. http:post:: /accounts
@@ -129,10 +129,10 @@ Account Management
challenge_contact_data?: ChallengeContactData;
// 'payto' address pointing a bank account
- // external to the libeufin-bank.
+ // external to the bank.
// Payments will be sent to this bank account
// when the user wants to convert the local currency
- // back to fiat currency outside libeufin-bank.
+ // back to fiat currency outside bank.
cashout_payto_uri?: string;
// Internal payto URI of this bank account.
@@ -208,10 +208,10 @@ Account Management
challenge_contact_data?: ChallengeContactData;
// 'payto' address pointing a bank account
- // external to the libeufin-bank.
+ // external to the bank.
// Payments will be sent to this bank account
// when the user wants to convert the local currency
- // back to fiat currency outside libeufin-bank.
+ // back to fiat currency outside the bank.
cashout_address?: string;
// Legal name associated with $username.
@@ -287,7 +287,7 @@ Account Management
balance: Balance;
// The account name (=username) of the
- // libeufin-bank account.
+ // bank account.
account_name: string;
}
@@ -348,7 +348,7 @@ Account Management
debit_threshold: Amount;
}
-.. _libeufin-bank-account-info:
+.. _bank-account-info:
.. http:get:: /accounts/$USERNAME
@@ -359,7 +359,7 @@ Account Management
**Response:**
:http:statuscode:`200 OK`:
- The libeufin-bank responds with an `AccountData` object.
+ The bank responds with an `AccountData` object.
**Details:**
@@ -591,7 +591,7 @@ Cashouts
Initiates a conversion to fiat currency. The external
bank account to be
credited is the one specified at registration time via the
- *cashout_address* parameter. The libeufin-bank internal account
+ *cashout_address* parameter. The bank internal account
is specified via ``$USERNAME``.
The bank sends a TAN to the customer to let them confirm the
operation. The request is only available to ordinary users, not
@@ -614,7 +614,7 @@ Cashouts
Assuming ``LIBEUFIN_CASHOUT_TEST_TAN`` is set to *T*, every */confirm*
operation can use *T* as the TAN. Setting instead the ``tan_channel``
field to ``file`` will cause the server to (over)write every TAN to
- ``/tmp/libeufin-cashout-tan.txt``. If both are used, the environment
+ ``/tmp/cashout-tan.txt``. If both are used, the environment
variable takes the precedence.
@@ -644,7 +644,7 @@ Cashouts
// That is the plain amount that the user specified
// to cashout. Its $currency is the (regional) currency of the
- // libeufin-bank instance.
+ // bank instance.
amount_debit: Amount;
// That is the amount that will effectively be
