taler-docs

commit e1dd76e8fb75f905ab7ffb263e94f8a43778aa07
parent 4085a5ee15f7c2629104c4c43037c71dd877d95a
Author: Antoine A <>
Date:   Tue,  6 Aug 2024 16:07:18 +0200

wire-gateway: clean doc

Diffstat:
M
core/api-bank-wire.rst
 | 
42
+++++++++++++++++++-----------------------

1 file changed, 19 insertions(+), 23 deletions(-)
diff --git a/core/api-bank-wire.rst b/core/api-bank-wire.rst
@@ -71,12 +71,15 @@ Making Transactions
 
 .. http:post:: /transfer
 
-  This API allows the exchange to make a transaction, typically to a merchant.  The bank account
-  of the exchange is not included in the request, but instead derived from the user name in the
-  authentication header and/or the request base URL.
+  Initiate a new wire transfer from the exchange's bank account, typically to a 
+  merchant.
+  
+  The exchange's bank account is not included in the request, but instead 
+  derived from the username in the ``Authorization`` header and/or the request 
+  base URL.
 
-  To make the API idempotent, the client must include a nonce.  Requests with the same nonce
-  are rejected unless the request is the same.
+  To make the API idempotent, the client must include a nonce. Requests with 
+  the same nonce are rejected unless the request is the same.
 
   **Request:**
 
@@ -84,7 +87,7 @@ Making Transactions
 
     interface TransferRequest {
       // Nonce to make the request idempotent.  Requests with the same
-      // ``request_uid`` that differ in any of the other fields
+      // ``request_uid`` that differs in any of the other fields
       // are rejected.
       request_uid: HashCode;
 
@@ -143,6 +146,10 @@ Making Transactions
 Querying the transaction history
 --------------------------------
 
+The exchange's bank account is derived from the username in the 
+``Authorization`` header and/or the request's base URL. In fact, the 
+transaction history may come from a "virtual" account, where several real bank 
+accounts are merged into a single history.  
 
 .. http:get:: /history/incoming
 
@@ -152,11 +159,6 @@ Querying the transaction history
   transaction does not conform to the right syntax, the wire gateway must not
   report it to the exchange, and send funds back to the sender if possible.
 
-  The bank account of the exchange is determined via the base URL and/or the
-  user name in the ``Authorization`` header.  In fact, the transaction history
-  might come from a "virtual" account, where multiple real bank accounts are
-  merged into one history.
-
   **Request:**
 
   :query limit: *Optional.*
@@ -283,11 +285,6 @@ Querying the transaction history
 
   Return a list of transactions made by the exchange, typically to a merchant.
 
-  The bank account of the exchange is determined via the base URL and/or the
-  user name in the ``Authorization`` header.  In fact, the transaction history
-  might come from a "virtual" account, where multiple real bank accounts are
-  merged into one history.
-
   **Request:**
 
   :query limit: *Optional.*
@@ -329,7 +326,6 @@ Querying the transaction history
       // Credit account is shared by all incoming transactions
       // as per the nature of the request.
       debit_account: string;
-
     }
 
   .. ts:def:: OutgoingBankTransaction
@@ -382,9 +378,9 @@ exposed by bank gateways in production.
       reserve_pub: EddsaPublicKey;
 
       // Account (as payto URI) that makes the wire transfer to the exchange.
-      // Usually this account must be created by the test harness before this API is
-      // used.  An exception is the "fakebank", where any debit account can be
-      // specified, as it is automatically created.
+      // Usually this account must be created by the test harness before this 
+      // API is used. An exception is the "fakebank", where any debit account 
+      // can be specified, as it is automatically created.
       debit_account: string;
     }
 
@@ -443,9 +439,9 @@ exposed by bank gateways in production.
       account_pub: EddsaPublicKey;
 
       // Account (as payto URI) that makes the wire transfer to the exchange.
-      // Usually this account must be created by the test harness before this API is
-      // used.  An exception is the "fakebank", where any debit account can be
-      // specified, as it is automatically created.
+      // Usually this account must be created by the test harness before this 
+      // API is used. An exception is the "fakebank", where any debit account 
+      // can be specified, as it is automatically created.
       debit_account: string;
     }