summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2017-05-03 15:41:54 +0200
committerMarcello Stanisci <marcello.stanisci@inria.fr>2017-05-03 15:41:54 +0200
commit054e4351f850625420ba10a3078bfc078a7cb0d9 (patch)
treead8dddb459894da36de34e2817ec1ce5a34794ed /api
parent70d08696750383d7192fc3f13770c8427e3cca99 (diff)
downloaddocs-054e4351f850625420ba10a3078bfc078a7cb0d9.tar.gz
docs-054e4351f850625420ba10a3078bfc078a7cb0d9.tar.bz2
docs-054e4351f850625420ba10a3078bfc078a7cb0d9.zip
refining bank's /history spec
Diffstat (limited to 'api')
-rw-r--r--api/api-bank.rst18
1 files changed, 12 insertions, 6 deletions
diff --git a/api/api-bank.rst b/api/api-bank.rst
index 1fec586f..099dbc91 100644
--- a/api/api-bank.rst
+++ b/api/api-bank.rst
@@ -115,9 +115,14 @@ the number of results.
.. http:post:: /history
-**Request:** The body of this request must have the format of a `HistoryRequest`_.
+ **Request**
+ :query direction: Optional parameter that lets the caller specify
+ only incoming, outgoing, or both types of records. If not given,
+ then the API will return both types; if set to `credit` (`debit`),
+ only incoming (outgoing) records are returned.
-**Response** JSON array of type `BankTransaction`_.
+
+ **Response** JSON array of type `BankTransaction`_.
@@ -135,12 +140,13 @@ the number of results.
// Amount transferred
amount: Amount;
- // "-" if the transfer was outcoming, "+" if it was
- // incoming.
+ // "-" if the transfer was outgoing, "+" if it was
+ // incoming. This field is only present if the argument
+ // `direction` was NOT given.
sign: string;
- // Bank account number of the other party
- // involved in the transaction.
+ // Bank account number of the other party involved in the
+ // transaction.
counterpart: number;
}