diff options
author | Marcello Stanisci <stanisci.m@gmail.com> | 2019-04-02 18:08:52 +0200 |
---|---|---|
committer | Marcello Stanisci <stanisci.m@gmail.com> | 2019-04-02 18:08:52 +0200 |
commit | 31aba41ec0294573e3c7a249abfbc9a5ceed0d6d (patch) | |
tree | 3a8e7f9aa2e95b7af47d2cdd740064b6b6b7f012 | |
parent | d8adcf20478b6cb0b228aaad8dd0f4f5ef835677 (diff) | |
download | docs-31aba41ec0294573e3c7a249abfbc9a5ceed0d6d.tar.gz docs-31aba41ec0294573e3c7a249abfbc9a5ceed0d6d.tar.bz2 docs-31aba41ec0294573e3c7a249abfbc9a5ceed0d6d.zip |
Spec'ing #5666.
-rw-r--r-- | api-bank.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/api-bank.rst b/api-bank.rst index f3024d89..9256e3d7 100644 --- a/api-bank.rst +++ b/api-bank.rst @@ -155,6 +155,27 @@ request. :status 404 Not Found: The bank does not know this rowid for this account. +.. http:get:: /history-range + + Filters and returns the list of transactions in the time range specified by `start` and `end` + + **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 start: unix timestamp indicating the oldest transaction accepted in the result. + :query end: unix timestamp indicating the youngest transaction accepted in the result. + :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. + :query ordering: can be `descending` or `ascending` and regulates whether the row are returned youger-to-older or vice versa. Defaults to `descending`. + + + **Response** + + :status 200 OK: JSON object whose field `data` is an array of type `BankTransaction`_. + :status 204 No content: in case no records exist for the targeted user. + + .. http:get:: /history Filters and returns the list of transactions of the customer specified in the request. |