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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
|
.. target audience: developer, core developer
.. _sandbox-api:
Sandbox API
###########
Demobanks.
==========
Sandbox is designed to allow multiple *demobanks* 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 segment ``/demobanks/default``, under which several
APIs are then served. The following sections describe all such APIs.
Customer API.
^^^^^^^^^^^^^
This API allows CRUD operations on the bank's customers (also referred
as 'users'). All the calls are allowed for the administrator, whereas
**only** the `password change <customer-password-modification>`_ is allowed
for ordinary customers.
The following endpoints are served under ``/demobanks/default/customer-api``.
.. http:post:: /customers
Create a new customer, including their bank account.
**Request:**
.. ts:def:: CustomerRequest
interface CustomerRequest {
// Username
username: string;
// Password.
password: string;
// E-Mail address
email: string;
// Phone number.
phone: string;
// Name denoting the legal subject being the customer.
name: string;
// 'payto' address pointing the bank account
// where to send payments, in case the customer
// wants to convert the local currency back to
// fiat.
payoutAddress: string;
// IBAN to assign to this bank account. Randomly
// generated, when it is not given.
iban?: string;
}
**Response:**
:http:statuscode:`204 No content`:
The customer was successfully created.
:http:statuscode:`409 Conflict`:
One information was not available, the error message should inform
about it.
:http:statuscode:`403 Forbidden`:
A istitutional username was attempted, like ``admin`` or ``bank``.
:http:statuscode:`404 Bad request`:
Input data was invalid. For example, the client specified a invalid
phone number or e-mail.
.. http:delete:: /customers
Delete a customer *with a zero balance* from the bank.
**Request:**
:query username: the username of the customer account to delete.
**Response:**
:http:statuscode:`204 No content`:
The customer account was successfully deleted.
:http:statuscode:`404 Not found`:
The customer specified along the parameters was not found.
:http:statuscode:`403 Forbidden`:
The administrator specified a istitutional username, like
``admin`` or ``bank``.
:http:statuscode:`412 Precondition failed`:
The balance of the customer to delete was not zero.
.. _customer-password-modification:
.. http:patch:: /customers
Allows administrators *and* ordinary customers to
change customer password.
**Request:**
.. ts:def:: CustomerPasswordChange
interface Customer {
// Username of the customer whose password is
// to be changed. It is optional in case the
// customer issues the request, because such information
// can be retrieved from the authentication credentials.
username?: string;
// New password.
newPassword: string;
}
**Response:**
:http:statuscode:`204 No content`:
Operation successful.
:http:statuscode:`403 Forbidden`:
A ordinary customer tried to change someone else's password.
This error should happen *before* checking whether the target
username exists, not to leak which usernames are already registered.
:http:statuscode:`404 Not found`:
The username whose password should be changed was not found.
.. http:get:: /customers
Allows the administrator to obtain a list of all the
customers registered at the bank. It returns only the
customer data (without any business information), because
:doc:`Access API </core/api-bank-access>` may already
be used for that.
**Response:**
.. ts:def:: Customers
interfaces Customers {
customers: CustomerData[];
}
.. ts:def:: CustomerData
interface CustomerData {
// Username
username: string;
// IBAN hosted at Libeufin Sandbox
iban: string;
// E-Mail address
email: string;
// Phone number.
phone: string;
// Name denoting the legal subject being the customer.
name: string;
// 'payto' address pointing the bank account
// where to send payments, in case the customer
// wants to convert the local currency back to
// fiat.
cashoutAddress: string;
}
.. http:post:: /cashouts
Lets the user specify an amount to be converted back
to fiat currency. The target account is the one specified
at registration time. The account to be debited is extracted
from the authentication credentials. The bank sends a TAN
to the customer, to let them confirm the operation.
..
FIXME: TAN first per e-mail, or phone?
**Request:**
.. ts:def:: CashoutRequest
interface CashoutRequest {
// Amount in the $currency:$value format.
amount: string;
}
**Response:**
.. ts:def:: CashoutPending
interface CashoutPending {
// UUID identifying the operation being created
// and now waiting the TAN confirmation.
uuid: string;
}
:http:statuscode:`202 Accepted`:
The cashout request was correctly created and
the TAN authentication now is pending.
:http:statuscode:`412 Precondition failed`:
Customer does not have sufficient funds.
:http:statuscode:`409 Conflict`:
A istitutional user (``admin`` or ``bank``) tried the operation.
.. http:post:: /cashouts/$cashoutId
Confirms the cashout with UUID $cashoutId by
accepting its TAN. Please note that the request
should still be authenticated with the users credentials.
**Request:**
.. ts:def:: CashoutConfirm
interface CashoutConfirm {
// the TAN that was shared by the bank that
// confirms $cashoutId.
tan: string;
}
**Response:**
:http:statuscode:`200 OK`:
cashout confirmed.
:http:statuscode:`401 Unauthorized`:
wrong TAN.
:http:statuscode:`409 Conflict`:
A istitutional user (``admin`` or ``bank``) tried the operation.
Access API.
^^^^^^^^^^^
Every endpoint is served under ``/demobanks/default/access-api``.
See :doc:`/core/api-bank-access`. This API allows users to access
their bank accounts and trigger Taler withdrawals.
Integration API.
^^^^^^^^^^^^^^^^
Every endpoint is served under ``/demobanks/default/integration-api``.
See :doc:`/core/api-bank-integration`. This API handles the communication
with Taler wallets.
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, but the rest of
this API does never involve the Sandbox.
EBICS API.
^^^^^^^^^^
.. _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;
}
.. note::
The following endpoints are **not** served under the ``/demobank/default`` segment.
Legacy API.
===========
This was the first API offered by Sandbox. It is used in
some test cases. One is hosted at the Wallet repository; other
MAY as well exist.
Except of the main EBICS handler located at "/ebicsweb", all
the EBICS calls have to authenticate the 'admin' user via
the HTTP basic auth scheme.
EBICS Hosts.
^^^^^^^^^^^^
.. http:post:: /admin/ebics/hosts
Create 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.
EBICS 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: {
userID: string;
partnerID: string;
systemID: string;
};
// IBAN
iban: string;
// BIC
bic: string;
// human name
name: string;
// bank account label
label: 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.
**Request:**
.. ts:def:: SubscriberRequestDeprecated
interface SubscriberRequestDeprecated {
// hostID
hostID: string;
// userID
userID: string;
// partnerID
partnerID: string;
// systemID, optional.
systemID: string;
}
Bank accounts.
^^^^^^^^^^^^^^
The access to a particular bank account is granted either to the
owner or to admin, via the HTTP basic auth scheme. A 'owner' is
a registered customer, who is identified by a username. The
registration of customers is offered via the :doc:`/core/api-bank-access`.
.. note::
The current version allows only one bank account per
customer, where the bank account name (also called 'label')
equals the owner's username.
.. http:get:: /admin/bank-accounts
Give summary of all the bank accounts. Only admin allowed.
**Response:**
.. ts:def:: AdminBankAccount
interface AdminBankAccount {
// IBAN
iban: string;
// BIC
bic: string;
// human name
name: string;
// bank account label
label: string;
}
.. http:get:: /admin/bank-accounts/$accountLabel
Give information about a bank account.
**Response:**
.. ts:def:: AdminBankAccountBalance
interface AdminBankAccountBalance {
// Balance in the $currency:$amount format.
balance: string;
// IBAN of the bank account identified by $accountLabel
iban: string;
// BIC of the bank account identified by $accountLabel
bic: string;
// Mentions $accountLabel
label: string;
}
.. http:post:: /admin/bank-accounts/$accountLabel
Create bank account. Existing users without a bank account
can request too.
**Request:** :ts:type:`AdminBankAccount`
Transactions.
^^^^^^^^^^^^^
.. http:get:: /admin/bank-accounts/$accountLabel/transactions
Inform about all the transactions of one bank account.
**Response:**
.. ts:def:: AdminTransactions
interface AdminTransactions {
payments: AdminTransaction[];
}
.. ts:def:: AdminTransaction
interface AdminTransaction {
// Label of the bank account involved in this payment.
accountLabel: string;
// Creditor IBAN
creditorIban: string;
// Debtor IBAN
debtorIban: string;
// UID given by one financial institute to this payment.
// FIXME: clarify whether that can be also assigned by
// the other party's institution.
accountServicerReference: string;
// ID of the Pain.001 that initiated this payment.
paymentInformationId: string;
// Unstructured remittance information.
subject: string;
// Date of the payment in the HTTP header format.
date: string;
// The number amount as a string.
amount: string;
// BIC of the creditor IBAN.
creditorBic: string;
// Legal name of the creditor.
creditorName: string;
// BIC of the debtor IBAN.
debtorBic: string;
// Legal name of the debtor.
debtorName: string;
// Payment's currency
currency: string;
// Have values 'credit' or 'debit' relative
// to the requesting user.
creditDebitIndicator: string;
}
.. http:post:: /admin/bank-accounts/$accountLabel/generate-transactions
Generate one incoming and one outgoing transaction for the bank account
identified by ``$accountLabel``. Only admin allowed.
.. 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. Only admin allowed.
**Request:**
.. ts:def:: AdminSimulateTransaction
interface AdminSimulateTransaction {
// Debtor IBAN.
debtorIban: string;
// Debtor BIC.
debtorBic: string;
// Debtor name.
debtorName: string;
// Amount number (without currency) as a string.
amount: string;
// Payment subject.
subject: string;
}
.. http:post:: /admin/payments/camt
Return the last camt.053 document from 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.
======
Errors
======
The JSON type coming along a non 2xx response is the following:
.. ts:def:: SandboxError
interface SandboxError {
error: SandboxErrorDetail;
}
.. ts:def:: SandboxErrorDetail
interface SandboxErrorDetail {
// String enum classifying the error.
type: ErrorType;
// Human-readable error description.
message: string;
}
.. ts:def:: ErrorType
enum ErrorType {
/**
* This error can be related to a business operation,
* a non-existent object requested by the client, or
* even when the bank itself fails.
*/
SandboxError = "sandbox-error",
/**
* It is the error type thrown by helper functions
* from the Util library. Those are used by both
* Sandbox and Nexus, therefore the actual meaning
* must be carried by the error 'message' field.
*/
UtilError = "util-error"
}
|