diff options
Diffstat (limited to 'api/api-bank.rst')
| -rw-r--r-- | api/api-bank.rst | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/api/api-bank.rst b/api/api-bank.rst index a4382a23..1d5e2f12 100644 --- a/api/api-bank.rst +++ b/api/api-bank.rst @@ -25,8 +25,9 @@ needs to give real money to the merchant. Administrative API ------------------ -This is `local` API, meant to make the bank communicate with trusted entities, -namely exchanges. +This API allows one user to send money to another user, withing the same "test" +bank. The user calling it has to authenticate by including his credentials in the +request. .. _bank-deposit: .. http:post:: /admin/add/incoming @@ -46,6 +47,12 @@ namely exchanges. interface BankDepositRequest { + // The username of the user calling this API. + username: string; + + // Password of the user calling this API. + password: string; + // JSON 'amount' object. The amount the caller wants to transfer // to the recipient's count amount: Amount; |