summaryrefslogtreecommitdiff
path: root/api-bank.rst
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2016-02-01 20:04:41 +0100
committerMarcello Stanisci <marcello.stanisci@inria.fr>2016-02-01 20:04:41 +0100
commit48d7b73e77f4567ce9dba6ee1f2024e9c001d4c8 (patch)
tree074a1dd1b36ca7c49b5e4ff234e5676bf852d7ab /api-bank.rst
parentc8cf08b7d23409070f7ea0ab48e26021c87f72f8 (diff)
downloaddocs-48d7b73e77f4567ce9dba6ee1f2024e9c001d4c8.tar.gz
docs-48d7b73e77f4567ce9dba6ee1f2024e9c001d4c8.tar.bz2
docs-48d7b73e77f4567ce9dba6ee1f2024e9c001d4c8.zip
bank: specing errors
Diffstat (limited to 'api-bank.rst')
-rw-r--r--api-bank.rst37
1 files changed, 25 insertions, 12 deletions
diff --git a/api-bank.rst b/api-bank.rst
index 0c1002f..d59cfd5 100644
--- a/api-bank.rst
+++ b/api-bank.rst
@@ -23,21 +23,34 @@ namely mints.
:status 200 OK: The request has been correctly handled, so the funds have been transferred to
the recipient's account
+
+:status 400 Bad Request: The bank replies a `BankIncomingError`_ object
**Details:**
- .. _BankDepositRequest:
- .. code-block:: tsref
+.. _BankDepositRequest:
+.. code-block:: tsref
- interface BankDepositRequest {
-
- // JSON 'amount' object. The amount the caller wants to transfer
- // to the recipient's count
- amount: Amount;
+ interface BankDepositRequest {
+
+ // JSON 'amount' object. The amount the caller wants to transfer
+ // to the recipient's count
+ amount: Amount;
- // The id of this wire transfer
- wid: base32;
+ // The id of this wire transfer
+ wid: base32;
- // The recipient's account identificator
- account: number;
+ // The recipient's account identificator
+ account: number;
- }
+ }
+
+.. _BankIncomingError:
+.. code-block:: tsref
+
+ interface BankIncomingError {
+
+ // The reason which made this request fail. Typically due to malfomation
+ // of the POST's body
+ reason: string
+
+ }