summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMS <ms@taler.net>2020-10-29 12:09:01 +0100
committerMS <ms@taler.net>2020-10-29 12:09:58 +0100
commit832bfa4d23fc670e8ec75c113a35c78d910676d4 (patch)
tree99b51b38aee66624ead8398928b4df699c5053dc
parenta85ae5e93c4f3587b32e72c909115a328019f857 (diff)
downloaddocs-832bfa4d23fc670e8ec75c113a35c78d910676d4.tar.gz
docs-832bfa4d23fc670e8ec75c113a35c78d910676d4.tar.bz2
docs-832bfa4d23fc670e8ec75c113a35c78d910676d4.zip
fix fetch-transactions request type
-rw-r--r--libeufin/api-nexus.rst43
1 files changed, 32 insertions, 11 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 6d8ecdb..bb5e48e 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -198,17 +198,38 @@ manages payment initiations of the account and tracks the initiations of payment
.. ts:def:: CollectedTransaction
interface CollectedTransaction {
- // Optional field to specify the bank connection to
- // use for such operation.
- bankConnection?: string;
- // dashed date (YYYY-MM-DD) of the earliest payment
- // in the result. Optional, defaults to "earliest
- // possible" date.
- start: string;
- // dashed date (YYYY-MM-DD) of the earliest payment
- // in the result. Optional, defaults to "latest
- // possible" date.
- end: string;
+
+ // This type indicates the time range of the query.
+ // It can assume the following values:
+ //
+ // 'latest': retrieves the last transactions from the bank.
+ // If there are older unread transactions, those will *not*
+ // be downloaded.
+ //
+ // 'all': retrieves all the transactions from the bank,
+ // until the oldest.
+ //
+ // 'previous-days': currently *not* implemented, it will allow
+ // the request to download transactions from
+ // today until N days before.
+ //
+ // 'since-last': retrieves all the transactions since the last
+ // time one was downloaded.
+ //
+ rangeType: string;
+
+ // Because transactions are delivered by banks in "batches",
+ // then every batch can have different qualities. This value
+ // lets the request specify which type of batch ought to be
+ // returned. Currently, the following two type are supported:
+ //
+ // 'report': intra-day information
+ // 'statement': prior day bank statement
+ level: string;
+
+ // Bank connection to use. It is a *optional* value that
+ // defaults to the default bank connection, if not given.
+ bankConnection: string;
}
.. http:get:: {nexusBase}/bank-accounts/{acctid}/transactions