summaryrefslogtreecommitdiff
path: root/libeufin/api-sandbox.rst
blob: b75fcf8df6eacfe35c1ad96b020a989c90f8156b (plain)
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
.. target audience: developer, core developer

.. _sandbox-api:

Current Sandbox API
###################

..
  Current Sandbox endpoints.

  GET /
  Welcome message.

  ** Camt debug **

  POST /admin/payments/camt 
  give last statement of requesting account

  ** Bank accounting **

  POST /admin/bank-accounts/$accountLabel 
  create bank account (no EBICS involved)

  GET /admin/bank-accounts
  Give summary of all the bank accounts.

  GET /admin/bank-accounts/$accountLabel 
  give general information about a bank account

  ** Transactions **

  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.

  GET /admin/bank-accounts/$accountLabel/transactions
  Inform about all the transactions of one bank account.

  POST /admin/bank-accounts/$accountLabel/generate-transactions
  Generate one incoming and one outgoing transaction
  for one bank account.

  ** EBICS subscribers management **

  POST /admin/ebics/subscribers
  Create a new EBICS subscriber.

  GET /admin/ebics/subscribers
  Give details of all the EBICS subscribers in the bank.

  POST /admin/ebics/bank-accounts
  Create a *new* bank account and link it with a existing
  EBICS subscriber.

  ** EBICS host management **

  POST /admin/ebics/hosts/$hostID/rotate-keys
  Change the bank's keys used in EBICS communication.

  POST /admin/ebics/hosts
  Create a new EBICS host.

  GET /admin/ebics/hosts
  Show details of all the EBICS hosts in the bank. 

  ** EBICS serving **

  POST /ebicsweb
  Processes a EBICS request.

  ** Taler .. **

  GET /taler
  Show one taler://-URI to initiate a withdrawal.

  - Taler integration API.

  - Demobank configuration API.
    ToDo.

  - Taler access API.
    ToDo.

EBICS.
^^^^^^

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;

     }


.. http:post:: /admin/ebics/subscribers

   Creates a new Ebics subscriber.

   **Request:**

   .. ts:def:: SubscriberRequest

     interface SubscriberRequest {

       // hostID
       hostID: string;

       // userID
       userID: string;

       // partnerID
       partnerID: string;

       // systemID
       systemID: 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;

      }


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.


Main EBICS service.
^^^^^^^^^^^^^^^^^^^

.. http:post:: /ebicsweb

   Serves all the Ebics requests.


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 expected Camt.053 document.

Future Sandbox API
##################

Resources.
----------

Sandbox serves the following resources:

 - Demobanks.
 - Bank accounts.
 - Subscribers.
 - Transactions.
 - Customers.
 - Reports.
 
The resources are subject to all CRUD operations, via by two
types of users: the 'admin' and the customers.  The admin has
rights on all of them.

One of the main differences with the previous versions is the
removal of the "/admin" initial component.  If the administrator
authenticates for one operation, then this one is of type `admin`:
no need for a dedicate and extra URI part.

For example, mocking transactions in the system was a typical
/admin-operation, but since transactions themselves are resources
and any resource is subject to CRUD operations, then mocking one
becomes just a `C` operation on the 'transactions' resources.  If
a test case wants to simplify the authentication - by hard-coding
the credentials, for example - before mocking one transaction, then
it can impersonate the administrator.

.. note::

   ``POST``-ing to a endpoint with a trailing ``$id`` means
   modification of a existing resource.

Demobanks
^^^^^^^^^

Demobanks are the main containers of all the other resources.
They take configuration values, like the currency for example.

.. http:get:: /admin/demobanks
.. http:get:: /admin/demobanks/$id
.. http:post:: /admin/demobanks
.. http:post:: /admin/demobanks/$id
.. http:delete:: /admin/demobanks/$id

Bank accounts.
^^^^^^^^^^^^^^

Bank accounts collect money of customers and participate
in transactions.

The ``$base`` is one demobank, in the form ``/demobanks/$id``.
That is due because a bank account must inherit some defaults
from the demobank, like the currency.

.. http:get:: $base/bankaccounts
.. http:get:: $base/bankaccounts/$id
.. http:post:: $base/bankaccounts
.. http:post:: $base/bankaccounts/$id
.. http:delete:: $base/bankaccounts/$id

Subscribers.
^^^^^^^^^^^^

Subscribers are (optional) customers identities for protocols
other than the native one.

A subscriber is not required to have a bank account `soon`.  Therefore,
it can be created, and later be linked to one bank account.  For this
reason, the ``$base`` should not mention one bank account.

.. note::

   Creating a subscriber is a time-consuming operation that goes often
   through slow channels, therefore it should basically never be done
   more than once.

.. http:get:: $base/subscribers
.. http:get:: $base/subscribers/$id
.. http:post:: $base/subscribers
.. http:post:: $base/subscribers/$id
.. http:delete:: $base/subscribers/$id

Transactions.
^^^^^^^^^^^^^

Transactions are money movements between bank accounts.

For convenience, ``$base`` **could** mention one bank account
to let customers see their transactions without defining "history"
query parameters: like ``$demobank/bankaccounts/$bankaccountId/transactions``.

At the same time, transactions should be easy to query regardless
of whose bank account they involve -- for administrative reasons, for
example.  Hence, a "global" URI scheme like ``$demobank/transactions?param=XXX``
should be offered as well.

.. http:get:: $base/transactions
.. http:get:: $base/transactions/$id
.. http:post:: $base/transactions
.. http:post:: $base/transactions/$id
.. http:delete:: $base/transactions/$id

Customers.
^^^^^^^^^^

Customers are persons that **can** have one bank account.  As
with subscribers, ``$base`` should not mention any bank account
so as to leave more flexibility to assign new bank accounts to
the same customer.

.. http:get:: $base/customers
.. http:get:: $base/customers/$id
.. http:post:: $base/customers
.. http:post:: $base/customers/$id
.. http:delete:: $base/customers/$id

Reports.
^^^^^^^^

Reports are persistent documents witnessing transactions.
A typical example is a Camt.053 statement.  A report lives
even after a bank account gets deleted or a customer leaves
the bank, therefore ``$base`` should only mention a demobank
instance.

.. http:get:: $base/reports
.. http:get:: $base/reports/$id
.. http:post:: $base/reports
.. http:post:: $base/reports/$id
.. http:delete:: $base/reports/$id