diff options
author | Marcello Stanisci <stanisci.m@gmail.com> | 2017-11-28 12:28:22 +0100 |
---|---|---|
committer | Marcello Stanisci <stanisci.m@gmail.com> | 2017-11-28 12:28:22 +0100 |
commit | 04b20f0c5ac90038349d72b38da562bf0562282e (patch) | |
tree | 39d83c28c887fa661c07e08fb807e77c3c84e604 /api-bank.rst | |
parent | 8adf148a388d595c4b964c4d14abfe8975805d3e (diff) | |
download | docs-04b20f0c5ac90038349d72b38da562bf0562282e.tar.gz docs-04b20f0c5ac90038349d72b38da562bf0562282e.tar.bz2 docs-04b20f0c5ac90038349d72b38da562bf0562282e.zip |
wording optional argument
Diffstat (limited to 'api-bank.rst')
-rw-r--r-- | api-bank.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/api-bank.rst b/api-bank.rst index a3137b6c..36162621 100644 --- a/api-bank.rst +++ b/api-bank.rst @@ -131,9 +131,10 @@ User API :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 direction: optional argument taking values `debit` or `credit`, according to the caller willing to receive both incoming and outgoing, only outgoing, or only incoming records. Takes `credit` by default. - :query account_number: optional argument indicating the bank account number whose history is to be returned. If not given, then the history of the calling user will be returned. - + :query direction: optional argument taking values `debit` or `credit`, according to the caller willing to receive both incoming and outgoing, only outgoing, or only incoming records. If not given, both directions are returned. + :query account_number: bank account whose history is to be returned. *Currently ignored*, as the multiple bank accounts per user is not implemented yet. + + **Response** :status 200 OK: JSON object whose field `data` is an array of type `BankTransaction`_. |