diff options
author | Marcello Stanisci <marcello.stanisci@inria.fr> | 2016-01-28 15:19:06 +0100 |
---|---|---|
committer | Marcello Stanisci <marcello.stanisci@inria.fr> | 2016-01-28 15:19:06 +0100 |
commit | 393758005dcdc2ff95ffc654d43719da3370fae5 (patch) | |
tree | 93990b1efaa10ec6fb32a63979fcf73ce24b78f3 /api-bank.rst | |
parent | 2f285ace2fcdc7993f8191716cfbbf7eb9466245 (diff) | |
download | docs-393758005dcdc2ff95ffc654d43719da3370fae5.tar.gz docs-393758005dcdc2ff95ffc654d43719da3370fae5.tar.bz2 docs-393758005dcdc2ff95ffc654d43719da3370fae5.zip |
fixing administrative bank API
Diffstat (limited to 'api-bank.rst')
-rw-r--r-- | api-bank.rst | 35 |
1 files changed, 15 insertions, 20 deletions
diff --git a/api-bank.rst b/api-bank.rst index ea07e3a8..0c1002fd 100644 --- a/api-bank.rst +++ b/api-bank.rst @@ -1,5 +1,5 @@ ========= -Banks API +Bank API ========= The following APIs are served from banks, in order to allow mints to @@ -7,12 +7,12 @@ deposit funds to money recipients. A typical scenario for calling this APIs is after a merchant has deposited coins to the mint, and the mint needs to give real money to the merchant. --------- -Test API --------- +------------------ +Administrative API +------------------ -This API is useful for testing purposes, as no real money will be -involved. +This is `local` API, meant to make the bank communicate with trusted entities, +namely mints. .. _bank-deposit: .. http:post:: /admin/add/incoming @@ -21,7 +21,8 @@ involved. **Response:** -:status 200: The request has been correctly handled, so the funds have been transferred to the merchant's account +:status 200 OK: The request has been correctly handled, so the funds have been transferred to +the recipient's account **Details:** .. _BankDepositRequest: @@ -31,18 +32,12 @@ involved. // JSON 'amount' object. The amount the caller wants to transfer // to the recipient's count - f: Amount; - - // The transaction id (meant as in 'Taler transaction id') according - // to which the caller is now giving money to the recipient. That way, - // the recipient can link inwards money to commercial activity. - tid: number; - - // The recipient's account identificator. For this testing purpose, the - // account format will the normal IBAN format having the token "TEST" - // in place of the country code and having the check digit removed. For instance, - // if "SA03 8000 0000 6080 1016 7519" were a valid Saudi Arabian IBAN, then - // "TEST 8000 0000 6080 1016 7519" would be a correct test account number as well. - account: string; + amount: Amount; + + // The id of this wire transfer + wid: base32; + + // The recipient's account identificator + account: number; } |