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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
.. target audience: developer, core developer
.. _sandbox-api:
Sandbox API
###########
Demobanks.
^^^^^^^^^^
Sandbox is designed to allow multiple banks being hosted,
where every demobank can have its own configuration (including
a different currency). A demobank has a name, although currently
only one demobank, named ``default``, is supported. Such demobank
activates the API trunk ``/demobanks/default``, under which other
APIs are then served. Those APIs include Access API, Integration
API, (part of the) Wire Gateway API (the add-incoming call), and
:ref:`one call to create EBICS subscribers <demobank-create-ebics-subscriber>`.
Access API.
^^^^^^^^^^
Every endpoint is served under ``/demobanks/default/access-api``.
See :doc:`/core/api-bank-access`.
Integration API.
^^^^^^^^^^^^^^^^
Every endpoint is served under ``/demobanks/default/integration-api``.
See :doc:`/core/api-bank-integration`.
Taler Wire Gateway API.
^^^^^^^^^^^^^^^^^^^^^^^
Served under ``/demobanks/default/taler-wire-gateway``. Currently,
only the :ref:`admin/add-incoming <twg-admin-add-incoming>` endpoint
is implemented. This endpoint allows testing, whereas the rest of
this API does never involve the Sandbox.
EBICS.
^^^^^^
HTTP Service
++++++++++++
.. http:post:: /ebicsweb
Serves all the Ebics requests.
Hosts.
++++++
.. http:post:: /admin/ebics/hosts
Creates a new Ebics host.
**Request:**
.. ts:def:: EbicsHostRequest
interface EbicsHostRequest {
// Ebics version.
hostID: string;
// Name of the host.
ebicsVersion: string;
}
.. http:get:: /admin/ebics/hosts
Shows the list of all the hosts in the system.
**Response:**
.. ts:def:: EbicsHostResponse
interface EbicsHostResponse {
// shows the host IDs that are active in the system.
// The Ebics version *is* missing, but it's still available
// via the HEV message.
ebicsHosts: string[];
}
.. http:post:: /admin/ebics/hosts/$hostID/rotate-keys
Overwrite the bank's Ebics keys with random ones. This is entirely
meant for tests (as the Sandbox itself is) and no backup will be
produced along this operation.
Subscribers.
++++++++++++
.. http:post:: /admin/ebics/bank-accounts
Associates a new bank account to an existing subscriber.
**Request:**
.. ts:def:: BankAccountRequest
interface BankAccountRequest {
// Ebics subscriber
subscriber: string;
// IBAN
iban: string;
// BIC
bic: string;
// human name
name: string;
// bank account label
label: string;
}
.. _demobank-create-ebics-subscriber:
.. http:post:: /demobanks/default/ebics/subscribers
Allows (only) the `admin` user to associate a bank account
to a EBICS subscriber. If the latter does not exist, it is
created.
**Request:**
.. ts:def:: SubscriberRequest
interface SubscriberRequest {
// hostID
hostID: string;
// userID
userID: string;
// partnerID
partnerID: string;
// systemID, optional.
systemID: string;
// Label of the bank account to associate with
// this subscriber.
demobankAccountLabel: string;
}
.. http:get:: /admin/ebics/subscribers
Shows the list of all the subscribers in the system.
**Response:**
.. ts:def:: SubscribersResponse
interface SubscribersResponse {
subscribers: Subscriber[]
}
.. ts:def:: Subscriber
interface Subscriber {
// userID
userID: string;
// partnerID
partnerID: string;
// hostID
hostID: string;
// Label of the bank account
// associated with this Ebics subscriber.
demobankAccountLabel: string;
}
.. http:post:: /admin/ebics/subscribers
Create a new EBICS subscriber without associating
a bank account to it. This call is **deprecated**.
Follow `this page <https://bugs.gnunet.org/view.php?id=7507>`_
for updates over the EBICS management REST design.
.. ts:def:: SubscriberRequestDeprecated
interface SubscriberRequestDeprecated {
// hostID
hostID: string;
// userID
userID: string;
// partnerID
partnerID: string;
// systemID, optional.
systemID: string;
}
Bank accounts.
^^^^^^^^^^^^^^
.. http:get:: /admin/bank-accounts
Give summary of all the bank accounts.
.. http:get:: /admin/bank-accounts/$accountLabel
Give information about a bank account.
.. http:post:: /admin/bank-accounts/$accountLabel
create bank account.
Transactions.
^^^^^^^^^^^^^
JSON.
+++++
.. http:get:: /admin/bank-accounts/$accountLabel/transactions
Inform about all the transactions of one bank account.
.. http:post:: /admin/bank-accounts/$accountLabel/generate-transactions
Generate one incoming and one outgoing transaction for one bank account.
.. http:post:: /admin/bank-accounts/$accountLabel/simulate-incoming-transaction
Book one incoming transaction for $accountLabel.
The debtor (not required to be in the same bank)
information is taken from the request.
Camt.
+++++
.. http:post:: /admin/payments/camt
Return the last statement of the requesting account.
**Request**
.. code-block:: tsref
interface CamtParams {
// label of the bank account being queried.
bankaccount: string;
// The Camt type to return. Only '53' is allowed
// at this moment.
type: number;
}
**Response**
The last Camt.053 document related to the bank account
mentioned in the request body.
|