1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
..
This file is part of GNU TALER.
Copyright (C) 2014, 2015, 2016 INRIA
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 2.1, or (at your option) any later version.
TALER is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with
TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
@author Marcello Stanisci
=========
Bank API
=========
The following APIs are served from banks, in order to allow exchanges to
deposit funds to money recipients. A typical scenario for calling this
APIs is after a merchant has deposited coins to the exchange, and the exchange
needs to give real money to the merchant.
------------------
Administrative API
------------------
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
**Request:** The body of this request must have the format of a `BankDepositRequest`_.
**Response:**
: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
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;
// Exchange base URL, used to perform tracking requests against the
// wire transfer ID. Note that in the actual bank wire transfer,
// the schema may have to be encoded differently, i.e.
// "https://exchange.com/" may become "https exchange.com" due to
// character set restrictions. It is the responsibility of the
// wire transfer adapter to properly encode/decode the URL.
// Payment service providers must ensure that their URL is short
// enough to fit together with the wire transfer identifier into
// the wire transfer subject of their respective banking system.
exchange_url: string;
// The id of this wire transfer, a `TALER_WireTransferIdentifierRawP`.
// Should be encoded together with a checksum in actual wire transfers.
// (See `TALER_WireTransferIdentifierP`_ for an encoding with CRC8.).
wtid: base32;
// The sender's account identificator
debit_account: number;
// The recipient's account identificator
credit_account: number;
}
.. _BankIncomingError:
.. code-block:: tsref
interface BankIncomingError {
// Human readable explanation of the failure.
reason: string;
}
--------
User API
--------
This API gets the user a list of his transactions, optionally limiting
the number of results.
.. http:post:: /history
**Request**
TBD
**Response**
TBD
--------
Util API
--------
Whenever the user wants to know the bank account number of a public account,
the following path returns a human readable HTML containing this information
`/public-accounts/details?account=accountName`
|
