commit fe375293120734270424032349798e952898bd36
parent d6c5eaa8b19a7d4cc108ffafd0691ad499238b84
Author: Marcello Stanisci <stanisci.m@gmail.com>
Date: Tue, 12 Feb 2019 18:21:26 +0100
Bank API.
Fix /history's "start" parameter description.
Diffstat:
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/api-bank.rst b/api-bank.rst
@@ -163,7 +163,7 @@ request.
:query auth: authentication method used. At this stage of development, only value `basic` is accepted. Note that username and password need to be given as request's headers. The dedicated headers are: `X-Taler-Bank-Username` and `X-Taler-Bank-Password`.
:query delta: returns the first `N` records younger (older) than `start` if `+N` (`-N`) is specified.
- :query start: according to `delta`, only those records with row id strictly greater (lesser) than `start` will be returned. This argument is optional; if not given, `delta` youngest records will be returned.
+ :query start: according to `delta`, only those records with row id strictly greater (lesser) than `start` will be returned. This argument is optional; if not given, it defaults to "MAX_UINT64".
:query direction: argument taking values `debit` or `credit`, according to the caller willing to receive both incoming and outgoing, only outgoing, or only incoming records. Use `both` to return both directions.
:query cancelled: argument taking values `omit` or `show` to filter out rejected transactions
:query account_number: bank account whose history is to be returned. *Currently ignored*, as multiple bank accounts per user are not implemented yet.
