From 832bfa4d23fc670e8ec75c113a35c78d910676d4 Mon Sep 17 00:00:00 2001 From: MS Date: Thu, 29 Oct 2020 12:09:01 +0100 Subject: fix fetch-transactions request type --- libeufin/api-nexus.rst | 43 ++++++++++++++++++++++++++++++++----------- 1 file changed, 32 insertions(+), 11 deletions(-) (limited to 'libeufin') diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst index 6d8ecdbe..bb5e48eb 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 -- cgit v1.2.3