commit 629e271c7a338b45295d17568dc10638a446d3ad
parent 378641298db343bc3ed65cf75e60fce4948c33b1
Author: Christian Grothoff <christian@grothoff.org>
Date: Fri, 20 Jun 2025 13:57:54 +0200
indent
Diffstat:
1 file changed, 53 insertions(+), 19 deletions(-)
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
@@ -888,7 +888,9 @@ Management operations authorized by master key
Only to be used by the exchange's offline key management team. Not useful
for anyone else.
- **Request:** The request body must be a `MasterSignatures` object.
+ **Request:**
+
+ The request body must be a `MasterSignatures` object.
**Response:**
@@ -946,7 +948,9 @@ Management operations authorized by master key
Only to be used by the exchange's offline key management team. Not useful
for anyone else.
- **Request:** The request body must be a `DenomRevocationSignature` object.
+ **Request:**
+
+ The request body must be a `DenomRevocationSignature` object.
**Response:**
@@ -974,7 +978,9 @@ Management operations authorized by master key
Only to be used by the exchange's offline key management team. Not useful
for anyone else.
- **Request:** The request body must be a `SignkeyRevocationSignature` object.
+ **Request:**
+
+ The request body must be a `SignkeyRevocationSignature` object.
**Response:**
@@ -1493,7 +1499,9 @@ for details.
cipher types, specifically at this point for Clause-Schnorr
blind signatures.
- **Request:** The request body must be a `BlindingPrepareRequest` object.
+ **Request:**
+
+ The request body must be a `BlindingPrepareRequest` object.
**Response:**
@@ -1659,7 +1667,9 @@ exchange.
recover the information if necessary in case of transient failures, like
power outage, network outage, etc.
- **Request:** The request body must be a `WithdrawRequest` object.
+ **Request:**
+
+ The request body must be a `WithdrawRequest` object.
**Response:**
@@ -2124,12 +2134,13 @@ Reserve History
The GET request should come with the following HTTP headers:
- ``If-None-Match``:
+ *If-None-Match*:
+
The client MAY provide an ``If-None-Match`` header with an
Etag. In that case, the server MUST additionally respond with an ``304``
status code in case the reserve history matches the provided Etag.
- ``Taler-Reserve-History-Signature``:
+ *Taler-Reserve-History-Signature*:
The client MUST provide Base-32 encoded
EdDSA signature over a ``TALER_SIGNATURE_RESERVE_HISTORY_REQUEST`` made with
the respective ``$RESERVE_PRIV``, affirming desire to download the current
@@ -2442,14 +2453,18 @@ Coin History
The GET request should come with the following HTTP headers:
- *If-None-Match*: The client MAY provide an ``If-None-Match`` header with an
+ *If-None-Match*:
+
+ The client MAY provide an ``If-None-Match`` header with an
Etag. In that case, the server MUST additionally respond with an ``304``
status code in case the coin history matches the provided Etag.
- *Taler-Coin-History-Signature*: The client MUST provide Base-32 encoded
- EdDSA signature over a TALER_SIGNATURE_COIN_HISTORY_REQUEST made with
- the respective ``$RESERVE_PRIV``, affirming desire to download the current
- coin transaction history.
+ *Taler-Coin-History-Signature*:
+
+ The client MUST provide Base-32 encoded EdDSA signature over a
+ TALER_SIGNATURE_COIN_HISTORY_REQUEST made with the respective
+ ``$RESERVE_PRIV``, affirming desire to download the current coin
+ transaction history.
:query start=OFFSET: *Optional.* Only return coin history entries with
offsets above the given OFFSET. Allows clients to not
@@ -3397,7 +3412,9 @@ in using this API.
.. note:: This endpoint is currently not implemented and the API going to change after **v27**. It is documented here as a placeholder for the documentation of the future endpoint.
- **Request:** The request body must be a `RecoupRequest` object.
+ **Request:**
+
+ The request body must be a `RecoupRequest` object.
**Response:**
@@ -3524,7 +3541,7 @@ in using this API.
**Request:**
- The request body must be a `RecoupRefreshRequest` object.
+ The request body must be a `RecoupRefreshRequest` object.
**Response:**
@@ -3820,7 +3837,9 @@ Refunds
Undo deposit of the given coin, restoring its value.
- **Request:** The request body must be a `RefundRequest` object.
+ **Request:**
+
+ The request body must be a `RefundRequest` object.
**Response:**
@@ -4203,9 +4222,13 @@ Wallet-to-wallet transfers
**Request:**
The request body must be empty, as recommended for HTTP delete in general.
- To authorize the request, the header must contain a
- ``Taler-Purse-Signature: $PURSE_SIG`` where ``$PURSE_SIG`` is the Crockford base32-encoded
- EdDSA signature of purpose TALER_SIGNATURE_WALLET_PURSE_DELETE.
+
+ To authorize the request, the header must contain the following HTTP header:
+
+ *Taler-Purse-Signature*:
+
+ $PURSE_SIG`` where ``$PURSE_SIG`` is the Crockford base32-encoded EdDSA
+ signature of purpose TALER_SIGNATURE_WALLET_PURSE_DELETE.
**Response:**
@@ -4948,6 +4971,7 @@ regulatory compliance.
**Request:**
*If-None-Match*:
+
The client MAY provide an ``If-None-Match`` header with an ETag.
:query timeout_ms=MILLISECONDS:
@@ -5210,6 +5234,7 @@ and freeze or unfreeze accounts suspected of money laundering.
**Request:**
*Taler-AML-Officer-Signature*:
+
The client must provide Base-32 encoded EdDSA signature with
``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that
this is merely a simple authentication mechanism, the details of the
@@ -5345,6 +5370,7 @@ and freeze or unfreeze accounts suspected of money laundering.
**Request:**
*Taler-AML-Officer-Signature*:
+
The client must provide Base-32 encoded EdDSA signature with
``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that this
is merely a simple authentication mechanism, the details of the request are
@@ -5381,6 +5407,7 @@ and freeze or unfreeze accounts suspected of money laundering.
**Request:**
*Taler-AML-Officer-Signature*:
+
The client must provide Base-32 encoded EdDSA signature with
``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that
this is merely a simple authentication mechanism, the details of the
@@ -5611,6 +5638,7 @@ and freeze or unfreeze accounts suspected of money laundering.
**Request:**
*Taler-AML-Officer-Signature*:
+
The client must provide Base-32 encoded EdDSA signature with
``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that
this is merely a simple authentication mechanism, the details of the
@@ -5683,6 +5711,7 @@ and freeze or unfreeze accounts suspected of money laundering.
**Request:**
*Taler-AML-Officer-Signature*:
+
The client must provide Base-32 encoded EdDSA signature with
``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that
this is merely a simple authentication mechanism, the details of the
@@ -5847,6 +5876,7 @@ and freeze or unfreeze accounts suspected of money laundering.
**Request:**
*Taler-AML-Officer-Signature*:
+
The client must provide Base-32 encoded EdDSA signature with
``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that
this is merely a simple authentication mechanism, the details of the
@@ -6227,7 +6257,11 @@ designated account.
**Request:**
- *Account-Request-Signature*: The client must provide Base-32 encoded EdDSA signature made with ``$ACCOUNT_PRIV``, affirming its authorization to delete the account. The purpose used MUST be ``TALER_SIGNATURE_RESERVE_CLOSE``.
+ *Account-Request-Signature*:
+
+ The client must provide Base-32 encoded EdDSA signature made with
+ ``$ACCOUNT_PRIV``, affirming its authorization to delete the account.
+ The purpose used MUST be ``TALER_SIGNATURE_RESERVE_CLOSE``.
:query force=BOOLEAN: *Optional.* If set to 'true' specified, the exchange
will delete the account even if there is a balance remaining.
