[taler-docs] branch master updated: bank gateway API

[gnunet]

This is an automated email from the git hooks/post-receive script.

dold pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 0e2f46a  bank gateway API
0e2f46a is described below

commit 0e2f46a0b1e8016c34765816a3efb43a750df0ed
Author: Florian Dold <address@hidden>
AuthorDate: Thu Jan 9 16:40:53 2020 +0100

    bank gateway API
---
 core/api-common.rst           | 20 ++++++++++++++++-
 core/api-wire-plugin-bank.rst | 51 +++++++++++++++++++++++++++++++++----------
 2 files changed, 58 insertions(+), 13 deletions(-)

diff --git a/core/api-common.rst b/core/api-common.rst
index 417ffac..f084c45 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -129,13 +129,31 @@ resulting encoding.
 
 Hash codes
 ^^^^^^^^^^
-Hashcodes are strings representing base32 encoding of the respective hashed
+Hash codes are strings representing base32 encoding of the respective hashed
 data. See `base32`_.
 
 .. ts:def:: HashCode
 
+  // 64-byte hash code
   type HashCode = string;
 
+.. ts:def:: ShortHashCode
+
+  // 32-byte hash code
+  type HashCode = string;
+
+Safe Integers
+^^^^^^^^^^^^^
+
+For easier browser-side processing, we restrict some integers to
+the range that is safely representable in JavaScript.
+
+.. ts:def:: SafeUint64
+
+  // Subset of numbers:  Integers in the
+  // inclusive range 0 .. (2^53 - 1)
+  type SafeUint64 = number;
+
 Large numbers
 ^^^^^^^^^^^^^
 
diff --git a/core/api-wire-plugin-bank.rst b/core/api-wire-plugin-bank.rst
index fae7727..420e8b1 100644
--- a/core/api-wire-plugin-bank.rst
+++ b/core/api-wire-plugin-bank.rst
@@ -72,23 +72,29 @@ Making Transactions
       timestamp: Timestamp;
 
       // Opaque of the transaction that the bank has made.
-      row_id: string;
+      row_id: SafeUint64;
     }
 
+
   .. ts:def:: TransactionRequest
 
     interface TransactionRequest {
       // Nonce to make the request idempotent.  Requests with the same
       // transaction_uid that differ in any of the other fields
       // are rejected.
-      transaction_uid: HashCode;
+      request_uid: HashCode;
 
       // Amount to transfer.
       amount: Amount;
 
-      // Reserve public key, will be included in the details
-      // of the wire transfer.
-      reserve_pub: string;
+      // Base URL of the exchange.  Shall be included by the bank gateway
+      // in the approriate section of the wire transfer details.
+      exchange_base_url: string;
+
+      // Wire transfer identifier chosen by the exchange,
+      // used by the merchant to identify the Taler order
+      // associated with this wire transfer.
+      wtid: ShortHashCode;
 
       // The recipient's account identifier as a payto URI
       credit_account: string;
@@ -113,9 +119,12 @@ Querying the transaction history
 
 .. http:get:: /taler/history
 
-  Return a list of transactions made to the exchange.  The transaction
-  list shall be filtered to only include transactions that include a valid
-  reserve public key.
+  Return a list of transactions made from or to the exchange.  The query
+  can be restricted to only include incoming or outgoing transactions.
+
+  Incoming transactions must contain a valid reserve public key and outgoing 
transactions
+  must include a valid wire transfer ID.  If a bank transaction does not 
confirm to the right syntax,
+  it must be ignored (and money sent back to the sender if possible).
 
   The bank account of the exchange is determined via the user name in the 
``Authorization`` header.
   In fact the transaction history might come from a "virtual" account, where 
multiple real bank accounts
@@ -131,7 +140,7 @@ Querying the transaction history
   * If *delta* is positive, return a list of up to *delta* transactions (all 
matching
     the filter criteria) strictly **after** the starting point.  The 
transactions are sorted
     in **ascending** order of the row ID.
-  * If *delta* is negative, return a list of up to *-delta* transactions 
(allmatching
+  * If *delta* is negative, return a list of up to *-delta* transactions (all 
matching
     the filter criteria) strictly **before** the starting point.  The 
transactions are sorted
     in **descending** order of the row ID.
 
@@ -146,6 +155,11 @@ Querying the transaction history
     Row identifier to explicitly set the *starting point* of the query.
   :query delta:
     The *delta* value that determines the range of the query.
+  :direction:
+    Filter transaction history by the direction of the transaction.
+    Can be "incoming" to only return transactions *to* the exchange,
+    *outgoing* to only return transactions *from* the exchange, or *both* 
(default)
+    to return both directions.
   :query long_poll_ms: *Optional.*  If this parameter is specified and the
     result of the query would be empty, the bank will wait up to 
``long_poll_ms``
     milliseconds for new transactions that match the query to arrive and only
@@ -163,7 +177,7 @@ Querying the transaction history
     interface BankTransaction {
 
       // Opaque identifier of the returned record
-      row_id: string;
+      row_id: SafeUint64;
 
       // Date of the transaction
       date: Timestamp;
@@ -171,10 +185,23 @@ Querying the transaction history
       // Amount transferred
       amount: Amount;
 
+      // Direction of the transfer
+      direction: "incoming" | "outgoing";
+
+      // Payto URI to identify the receiver of funds.
+      // If direction is "incoming", this is one of the exchange's bank 
accounts.
+      credit_account: string;
+
       // Payto URI to identify the sender of funds
+      // If direction is "outgoing", this is one of the exchange's bank 
accounts.
       debit_account: string;
 
-      // The reserve public key extracted from the transaction details
-      reserve_pub: string;
+      // The reserve public key extracted from the transaction details.
+      // Must be present iff the direction is "incoming".
+      reserve_pub?: EddsaPublicKey;
+
+      // The reserve public key extracted from the transaction details,
+      // Must be present iff the direction is "outgoing".
+      wtid?: ShortHashCode;
     }
 

-- 
To stop receiving notification emails like this one, please contact
address@hidden.