[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-docs] branch master updated (143ad12 -> 71b5710)

From: gnunet
Subject: [taler-docs] branch master updated (143ad12 -> 71b5710)
Date: Wed, 12 Apr 2023 12:25:10 +0200

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

ms pushed a change to branch master
in repository docs.

    from 143ad12  Access API.
     new c2868fc  Nexus API.
     new 71b5710  Nexus API.

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

Summary of changes:
 libeufin/api-nexus.rst | 35 +++++++++++++++++++++++++++++++----
 1 file changed, 31 insertions(+), 4 deletions(-)

diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 065eb9f..cf0e02a 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -379,17 +379,44 @@ tracks the initiations of payments.
 .. http:get:: {nexusBase}/bank-accounts/{acctid}/transactions
-  Shows all the transactions fetched for ``{acctid}``.
+  Shows the transactions fetched for ``{acctid}``, according to
+  the URI parameters.
-  **Query parameters:**
+  **Request:**
+  :query long_poll_ms: Optional number to express how many milliseconds
+    the server should wait for at least one result to be shown.  If not
+    given, the server responds immediately, regardless of the result.
+  :query start: Optional number to express the **earliest** transaction
+    index, starting from **1**.  For example, if *start* is 6 and three
+    transactions are returned, they will have the following indexes:
+    6, x, y, where x and y are both greater than 6 but not necessarily
+    sequential.  This parameter defaults to 1.
+  :query size:  Optional number indicating how many transactions are to
+    be included in the response.  It defaults to 5.
-  **Response:** A object with a unique field named ``transactions``
-  that contains a list of `Transaction` objects.
+  **Response:**
+  :http:statuscode:`200 OK`:
+  a JSON object with a unique field named ``transactions`` that
+  is a list of `Transaction` objects.  This status code applies
+  even for an **empty** list.  The list is such that index **x-1**
+  is always a **earlier** transaction than **x**.  For example, the
+  transaction having the 'start' index lies always at index zero.
+  Note that the order does NOT reflect the transaction's timestamp
+  as given by the bank, but rather the order that Nexus stored them
+  into its database.
   .. ts:def:: Transaction
      interface Transaction {
+       // index identifying this transaction at Nexus.
+       // Note: users can ONLY expect that this index grows
+       // as new transactions get fetched from the bank, but
+       // should NOT expect it to grow continuously.
+       index: number;
        // money moved by the transaction
        amount: string;

To stop receiving notification emails like this one, please contact

reply via email to

[Prev in Thread] Current Thread [Next in Thread]