summaryrefslogtreecommitdiff
path: root/libeufin/api-nexus.rst
blob: 5f3e7a6c8ffd871c15a9430feb1917d363ca8148 (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
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
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
.. target audience: core developer

Nexus API
###########

.. contents:: Table of Contents

HTTP API
========

Configuration
-------------

Returns configuration values currently used by the Nexus process.
This API is mostly used by testing jobs.

.. http:get:: {nexusBase}/service-config

  **Response:**

  .. ts:def:: ServiceConfigResponse

     interface ConfigResponse {

       // Connection string to the database.
       dbConn: string;
     }


Returns configuration values currently used by Nexus.

.. http:get:: {nexusBase}/config

  **Response:**

  .. ts:def:: ConfigResponse

     interface ConfigResponse {

       currency: string;

       // nexus version, X.Y.Z format.
       version: string;
     }


Authentication
--------------

Currently every request made to nexus must be authenticated using the *HTTP
basic auth* mechanism.

Other authentication mechanisms (e.g. OpenID Connect) might
be supported in the future.

User Management
---------------

.. http:get:: {nexusBase}/user

  Get information about the current user (based on the authentication information
  in this request).

  **Response:**

  .. ts:def:: GetUserResponse

     interface UserResponse {

       // User name
       username: string;

       // Password
       password: string;
     }

.. http:post:: {nexusBase}/users/password

  Change password of a user.  The username is extracted from
  the HTTP authentication parameters.

  **Request:**

  .. code-block:: ts

    interface UserChangePassword {
      newPassword: string;
    }

.. http:post:: {nexusBase}/users

  Create a new user.  Only a superuser can call this API.

  **Request:**

  The body is a `User` object.

  **Response:**

  :http:statuscode:`409 Conflict`: Username is not available.

  **Details:**

  .. ts:def:: User

     interface User {

       // User name
       username: string;

       // Initial password
       password: string;
     }


.. http:get:: {nexusBase}/users

  Return list of users.

.. _nexus-permissions-api:

Permissions API
---------------

The permissions API manages authorization of access of subjects (usually users)
to resources.

Permissions are modeled a set of ``(subject, resource, permission)`` triples.
Subjects and resources consist of a type and an identifier.

Superusers are not subject to further permission checks, they are allowed
to do any operation.

The following subject types are currently supported:

* ``user``:  An authenticated user.  The subject ID
  is interpreted as the user ID.

The following permissions are currently defined:

* ``facade.talerWireGateway.history``:  Allows querying the
  transaction history through a Taler wire gateway facade.
* ``facade.talerWireGateway.transfer``: Allows creating payment initiations
  to transfer money via a Taler wire gateway facade.

The following resource IDs are currently supported:

* ``facade``: A LibEuFin facade.  The resource ID is interpreted as the
  facade name.

.. http:get:: {nexusbase}/permissions

   List all permissions.

   **Response**

  .. ts:def:: QueryPermissionsResponse

     interface QueryPermissionsResponse {
       permissions: {
         subjectType: string;
         subjectId: string;
         resourceType: string;
         resourceId: string;
         permissionName: string
       }[];
     }

.. http:post:: {nexusbase}/permissions

   Modify permissions.

   **Request**

  .. ts:def:: QueryPermissionsResponse

     interface QueryPermissionsResponse {
       action: "grant" | "revoke";
       permission: {
         subjectType: string;
         subjectId: string;
         resourceType: string;
         resourceId: string;
         permissionName: string
       };
     }

   **Response**

   The response is an empty JSON object.


Test API
--------


.. http:post:: {nexusbase}/bank-accounts/{acctid}/test-camt-ingestion/{type}

  This call allows tests to **directly** give Nexus a Camt document.  After
  the processing, all the payment(s) details should be ingested as if the
  Camt came normally from a bank / the Sandbox.  ``acctid`` must match the
  label of a locally imported bank account, and ``type`` for now can only be
  ``C53``.

  **Response**

  The successful case should respond with a ``200 OK`` and a empty JSON body.


Bank Accounts
-------------

The LibEuFin maintains a copy of the bank account transaction history and balance information,
manages payment initiations of the account and tracks the initiations of payments.

.. http:get:: {nexusBase}/bank-accounts

  **Response:**

  A list of `BankAccount` objects
  that belong to the requester.

  .. ts:def:: BankAccount

     interface BankAccount {
       // mnemonic name identifying this bank account.
       nexusBankAccountId: string;
       // IBAN
       iban: string;
       // BIC
       bic: string;
       // Legal subject owning the account.
       ownerName: string;
     }


.. http:get:: {nexusBase}/bank-accounts/{my-acct}

   Get basic information about the bank account named ``my-acct``.

   interface BankAccountInfoWithBalance {
     // ID number of the database row being the default bank connection
     // of `my-acct`.
     defaultBankConnection: number;
     // Payto://-URI of `my-acct`.
     accountPaytoUri: string;
     // Balance of `my-acct` as it was downloaded from the bank
     // along the last Camt document.  A human-readable message
     // will inform the requester, should this value not be found.
     lastSeenBalance: string;
   }

.. http:post:: {nexusBase}/bank-accounts/{acctid}/payment-initiations/{pmtid}/submit

  Ask nexus to submit one prepare payment at the bank.

  :http:statuscode:`404 Not found`: the unique identifier **or**
  the bank connection could not be found in the system


.. http:get:: {nexus}/bank-accounts/{my-acct}/payment-initiations/{uuid}

   Ask the status of payment ``$uuid``.

   **Response:**

   .. ts:def:: PaymentStatus

      interface PaymentStatus {
        // Can be "BOOK" or "PDNG" ('pending').
        status: string;

        // Payment unique identifier
        paymentInitiationId: string;

        // True for submitted payments
        submitted: boolean;

        // Creditor IBAN
        creditorIban: string;

        // Creditor BIC
        creditorBic: string;

        // Creditor legal name
        creditorName: string;

        // Amount
        amount: string;

        // Subject
        subject: string;

        // Date of submission (in dashed form YYYY-MM-DD)
        submissionDate: string;

        // Date of preparation (in dashed form YYYY-MM-DD)
        preparationDate: string;
      }

.. http:get:: {nexusBase}/bank-accounts/{my-acct}/payment-initiations

  Ask nexus the list of initiated payments.  At this stage of the API,
  **all** is returned: submitted and non-submitted payments.

  **Response**

  .. ts:def:: InitiatedPayments

     interface InitiatedPayments {

       // list of all the initiated payments' UID.
       initiatedPayments: PaymentStatus[];
     }


.. http:post:: {nexusBase}/bank-accounts/{my-acct}/payment-initiations

  Ask nexus to prepare instructions for a new payment.
  Note that ``my-acct`` is the bank account that will be
  **debited** after this operation.

  **Request:**

  .. ts:def:: PreparedPaymentRequest

     interface PreparedPaymentRequest {
       // IBAN that will receive the payment.
       iban: string;
       // BIC hosting the IBAN.
       bic: string;
       // Legal subject that will receive the payment.
       name: string;
       // payment subject.
       subject: string;
       // amount, in the format CURRENCY:XX.YY
       amount: string
     }

  **Response:**

  .. ts:def:: PreparedPaymentResponse

     interface PreparedPaymentResponse {

       // Opaque identifier to be communicated when
       // the user wants to submit the payment to the
       // bank.
       uuid: string;
     }

.. http:post:: {nexusBase}/bank-accounts/{acctid}/fetch-transactions

  Nexus will download bank transactions using the given connection.

  **Request:**

  .. ts:def:: CollectedTransaction

     interface CollectedTransaction {

         // This type indicates the time range of the query.
         // It can assume the following values:
         //
         // 'latest': retrieves the last transactions from the bank.
         //           If there are older unread transactions, those will *not*
         //           be downloaded.
         //
         // 'all': retrieves all the transactions from the bank,
         //        until the oldest.
         //
         // 'previous-days': currently *not* implemented, it will allow
         //                  the request to download transactions from
         //                  today until N days before.
         //
         // 'since-last': retrieves all the transactions since the last
         //               time one was downloaded.
         //
         rangeType: string;

         // Because transactions are delivered by banks in "batches",
         // then every batch can have different qualities.  This value
         // lets the request specify which type of batch ought to be
         // returned.  Currently, the following two type are supported:
         //
         // 'report': intra-day information
         // 'statement': prior day bank statement
         level: string;

         // Bank connection to use.  It is a *optional* value that
         // defaults to the default bank connection, if not given.
         bankConnection: string;
     }

  **Response:**

  .. code-block:: ts

    interface NewTransactions {
      // How many transactions are new to Nexus.
      newTransactions: number;
      // How many transactions got downloaded by the request.
      // Note that a transaction can be downloaded multiple
      // times but only counts as new once.
      downloadedTransactions: number;
    }

.. http:get:: {nexusBase}/bank-accounts/{acctid}/transactions

  Shows which transactions are stored locally at nexus.

  **Query parameters:**

  * **start** start (dashed YYYY-MM-DD) date of desired payments.
    Optional, defaults to "earliest possible" date.
  * **end** end (dashed YYYY-MM-DD) date of desired payments.
    Optional, defaults to "earliest possible" date.


  **Response:** A object with a unique field named ``transactions``
  that contains a list of `Transaction` objects.

  .. ts:def:: Transaction

     interface Transaction {

       // money moved by the transaction
       amount: string;

       // CRDT or DBIT
       creditDebitIndicator: string

       // Two of the most used values are BOOK, or PENDING
       status: string;

       // FIXME
       bankTransactionCode: string;

       // FIXME
       valueDate: string;

       // When this payment got booked.  In the form YYYY-MM-DD
       bookingDate: string;

       // FIXME
       accountServicerRef: string;

       // FIXME
       batches: {
         // list of batched transactions
         batchTransactions: BatchedTransaction[];
       };
     }

  .. ts:def:: BatchedTransaction

     interface BatchedTransaction {
       // FIXME
       amount: string;
       // FIXME
       creditDebitIndicator: string;
       // FIXME
       details {
         debtor: {
           name: string;
         };
         debtorAccount: {
           iban: string;
         };
         // Missing, when the payment is DBIT.
         debtorAgent: {
           bic: string;
         };
         creditor: {
           name: string;
         };
         creditorAccount: {
           iban: string;
         };
         // Missing, when the payment is CRDT.
         creditorAgent: {
           iban: string;
         };
         // FIXME
         endToEndId: string;
         // FIXME
         unstructuredRemittanceInformation: string;
       }
     }

Scheduling API
--------------

.. http:post:: {nexusBase}/bank-accounts/{acctid}/schedule

  This endpoint allows the caller to define a recurrent
  execution of a task.

  **Request**

  .. ts:def:: ScheduleTask

    interface ScheduleTask {
      name: string;

      // a Unix-compatible cron pattern representing
      // the frequency of execution of this task.
      cronspec: string;

      // Can take values "fetch" (to download the history
      // of the requester's bank account) or "submit" (to submit
      // any initiated payment associated to the requester's
      // bank account).
      type: string;

      // Currently only used for "fetch" operations
      params: {
        level: "report" | "statement" | "all";
        rangeType: "latest" | "all" | "previous-days" | "since-last";
      };
    }



.. http:get:: {nexusBase}/bank-accounts/{acctid}/schedule/{taskId}

  **Response**

  .. ts:def:: NexusTask

     // This object is a mere reflection of
     // what the Nexus database keeps to implement
     // the scheduling feature.

     interface NexusTask {
       // FIXME: document all.
       resourceType: string;
       resourceId: string;
       taskName: string;
       taskType: string;
       taskCronSpec: string;
       taskParams: string;
       nextScheduledExecutionSec: number;
       prevScheduledExecutionSec: number;
     }


.. http:delete:: {nexusBase}/bank-accounts/{acctid}/schedule/{taskId}

  This call deletes the task associated to ``taskId``.

.. http:get:: {nexusBase}/bank-accounts/{acctid}/schedule

  **Response**

  .. code-block:: ts

    interface TaskCollection {

      // This field can contain *multiple* objects of the type sampled below.
      schedule: {

        'task-name': {
          cronspec: string;
          type: string; // fetch | submit

          // Depends on the type.  Submit has it empty, whereas
          // the fetch type includes the time range and the report
          // level.
          params: any;
        }
      }
    }


Bank Connections
----------------

Bank connections connect the local LibEuFin bank account
to the real bank.

.. http:post:: <nexus>/bank-connections

  Activate a new bank connection for the requesting user.

  **Request:**

  This request can accept two formats, depending on whether a
  new bank connection is being made, or a connection backup is
  being restored.


  This type allows the creation of new bank accounts.

  .. ts:def:: NewBankConnection

     interface NewBankConnection {

       source: string; // only "new" allowed

       // connection name.
       name: string;

       // type of the connection to make: "ebics" for example.
       type: string;

       data: BankConnectionNew;
     }

  This type allows to restore a previously made bank connection.

  .. ts:def:: BankConnectionRestoreRequest

     interface BankConnectionRestoreRequest {

       source: "backup";

       // connection name.
       name: string;

       // Backup data, as typically returned by the "../export-backup" API.
       backup: BankConnectionBackup;

       passphrase?: string;
     }


  .. ts:def:: BankConnectionNew

     interface BankConnectionNew {

       // This type is strictly dependent on
       // the connection being created.  For Ebics,
       // it will contain the required fields (as strings):
       // 'ebicsURL', 'userID', 'partnerID', 'hostID', and
       // the optional 'systemID'.

       // Other connection types, like 'local' (used for testing
       // purposes skipping any interaction with the bank service)
       // and 'fints' are all work in progress!

     }


  .. ts:def:: BankConnectionBackup

     interface BankConnectionBackup {

       // The information needed in this type depend entirely
       // on which connection is being restored.
     }

  **Response:**

  :http:statuscode:`406 Not acceptable`: a connection with the
  requested name already exists for this user.

.. http:post:: {nexusBase}/bank-connections/delete-connection

  **Request:**

  .. ts:def:: BankConnectionDeletion

      interface BankConnectionDeletion {
        // label of the bank connection to delete
        bankConnectionId: string;
      }

.. http:get:: {nexusBase}/bank-connections

   List available bank connections.

   **Response**

   A JSON object whose ``bankConnections`` element is a list of the following type:

   .. ts:def:: BankConnection

       interface BankConnection {

         // connection type.  For example "ebics".
         type: string;

         // connection name as given by the user at
         // the moment of creation.
         name: string;
       }


.. http:get:: {nexusBase}/bank-connections/{connId}

   Get information about one bank connection.

   .. ts:def:: BankConnectionInfo

      interface BankConnectionInfo {
        type: string;
        owner: string;
        // if true, this connection can be used to communicate
        // with the bank.
        ready: boolean;
        // Depends on the type.
        details: any;
      }


.. http:post:: {nexusBase}/bank-connections/{connId}/connect

   Initialize the connection by talking to the bank.

.. http:post:: {nexusBase}/bank-connections/{connId}/export-backup

   Make a passphrase-encrypted backup of this connection.

.. http:post:: {nexusBase}/bank-connections/{connId}/fetch-accounts

   Update accounts that are accessible via this bank connection.

.. http:get:: {nexusBase}/bank-connections/{connId}/accounts

   List the bank accounts that this bank connection provides access to.

  .. ts:def:: OfferedBankAccount

     interface OfferedBankAccount {

       // Unique identifier for the offered account
       offeredAccountId: string;

       // IBAN of the offered account
       iban: string;

       // BIC of the account's financial institution
       bic: string;

       // Account owner name
       ownerName: string;

       // If the account has been imported,
       // this field contains the ID of the
       // Nexus bank account associated with it.
       nexusBankAccountId: string | null;
     }

.. http:post:: {nexusBase}/bank-connections/{connId}/import-account

  Import a bank account provided by the connection into the Nexus.

  If no Nexus bank account with the ID ``nexusBankAccountId`` exists,
  a new one will be created, and it will have ``connId`` as the
  default bank connection.

  If an existing Nexus bank account with the same ID already exists,
  this connection will be added as an available connection for it.
  This only succeeds if the bank account has the same IBAN.

  .. ts:def:: ImportBankAccount

     interface ImportBankAccount {

       // Identifier for the bank account, as returned by /accounts
       // of the bank connection.
       offeredAccountId: string;

       // Nexus-local identifier for the bank account.
       nexusBankAccountId: string;
     }


.. http:get:: <nexus>/bank-connections/{connId}/messages

  List *some* details of all the ISO2022 messages gotten from the bank.  It
  responds with a list of the following elements:

  .. code-block:: ts

    interface BankMessageInfo {

      // the message type, typically how the containing layer
      // (Ebics, for example) would label this information.  For
      // Camt.053 types, this value is "C53".
      code: string;

      // the unique identifier of the message.
      messageId: string;

      // bytes length of the message.
      length: number;
    }



.. http:get:: <nexus>/bank-connections/{connId}/messages/{msgId}

  Return the ISO20022 XML corresponding to ``msgId``.


Facades
-------

.. http:get:: <nexus>/facades/{fcid}

   **Response:** A `FacadeShowInfo` pointed to by ``fcid``.


.. http:get:: <nexus>/facades

  List available facades that belong to the requesting user.

  **Response:**  A list of the following elements:

.. ts:def:: FacadeShowInfo

    interface FacadeShowInfo {

      // Name of the facade, same as the "fcid" parameter.
      name: string;

      // Type of the facade.
      // For example, "taler-wire-gateway".
      type: string;

      // Bas URL of the facade.
      baseUrl: string;

      // details depending on the facade type.
      config: any;
    }

.. http:delete:: {nexus}/facades/{fcid}

  Delete a facade.

.. http:post:: {nexus}/facades

  Create a new facade.

  **Request:**

  .. code-block:: ts

     interface FacadeInfo {
        // Name of the facade, same as the "fcid" parameter.
        name: string;

        // Type of the facade.
        // For example, "taler-wire-gateway" or "anastasis".
        type: string;

        // Bank accounts that the facade has read/write
        // access to.
        bankAccountsRead: string[];
        bankAccountsWrite: string[];

        // Bank connections that the facade has read/write
        // access to.
        bankConnectionsRead: string[];
        bankConnectionsWrite: string[];

        // Facade-specific configuration details.
        config: any;
     }


Bank Connection Protocols
-------------------------

.. http:get:: {nexus}/bank-connection-protocols

   List supported bank connection protocols.

.. http:post:: {nexus}/bank-connection-protocols/ebics/test-host

   Check if the nexus can talk to an EBICS host.
   This doesn't create a new connection in the database,
   and is useful during setup when the user hasn't entered
   the full details for the connection yet.

   .. ts:def:: EbicsHostTestRequest

      interface EbicsHostTestRequest {
        ebicsBaseUrl: string;
        ebicsHostId: string;
      }


EBICS-specific APIs
-------------------

The following endpoints are only available for EBICS bank connections.
They are namespaced under the ``/ebics/`` sub-resource.

.. http:post:: {nexusBase}/bank-connections/{connection-name}/ebics/download/{msg}

  .. warning::

    Use with care.  Typically only necessary for testing and debugging.

  Perform an EBICS download transaction of type ``msg``.
  This request will not affect any bank account or other state
  in the nexus database.  It will just make a request to the bank
  and return the answer.

.. http:post:: {nexusBase}/bank-connections/{connection-name}/ebics/upload/{msg}

  .. warning::

    Use with care.  Typically only necessary for testing and debugging.

  Perform an EBICS upload transaction of type ``msg``.
  This request will not affect any bank account or other state
  in the nexus database.  It will just make a request to the bank
  and return the answer.

Anastasis API.
--------------

This is a read-only API offering a view over *only* the incoming
transactions of a bank account.  It is named after the typical user -
a Anastasis service - but can be used in any case where only the
incoming transactions are of interest.

.. http:get:: ${BASE_URL}/history/incoming

  Return a list of transactions made to the customer.

  The bank account of the customer is determined via the base URL and/or the
  user name in the ``Authorization`` header.  In fact the transaction history
  might come from a "virtual" account, where multiple real bank accounts are
  merged into one history.

  Transactions are identified by an opaque numeric identifier, referred to here
  as *row ID*.  The semantics of the row ID (including its sorting order) are
  determined by the bank server and completely opaque to the client.

  The list of returned transactions is determined by a row ID *starting point*
  and a signed non-zero integer *delta*:

  * If *delta* is positive, return a list of up to *delta* transactions (all matching
    the filter criteria) strictly **after** the starting point.  The transactions are sorted
    in **ascending** order of the row ID.
  * If *delta* is negative, return a list of up to *-delta* transactions (all matching
    the filter criteria) strictly **before** the starting point.  The transactions are sorted
    in **descending** order of the row ID.

  If *starting point* is not explicitly given, it defaults to:

  * A value that is **smaller** than all other row IDs if *delta* is **positive**.
  * A value that is **larger** than all other row IDs if *delta* is **negative**.

  **Request**

  :query start: *Optional.*
    Row identifier to explicitly set the *starting point* of the query.
  :query delta:
    The *delta* value that determines the range of the query.
  :query long_poll_ms: *Optional.*  If this parameter is specified and the
    result of the query would be empty, the bank will wait up to ``long_poll_ms``
    milliseconds for new transactions that match the query to arrive and only
    then send the HTTP response.  A client must never rely on this behavior, as
    the bank may return a response immediately or after waiting only a fraction
    of ``long_poll_ms``.

  **Response**

  :http:statuscode:`200 OK`: JSON object of type `IncomingHistory`.
  :http:statuscode:`400 Bad request`: Request malformed. The bank replies with an `ErrorDetail` object.
  :http:statuscode:`401 Unauthorized`: Authentication failed, likely the credentials are wrong.
  :http:statuscode:`404 Not found`: The endpoint is wrong or the user name is unknown. The bank replies with an `ErrorDetail` object.

  .. ts:def:: IncomingHistory

    interface IncomingHistory {

      // Array of incoming transactions.
      incoming_transactions : IncomingBankTransaction[];

    }

  .. ts:def:: IncomingBankTransaction

    interface IncomingBankTransaction {

      // Opaque identifier of the returned record.
      row_id: SafeUint64;

      // Date of the transaction.
      date: Timestamp;

      // Amount transferred.
      amount: Amount;

      // Payto URI to identify the receiver of funds.
      // This must be one of the exchange's bank accounts.
      credit_account: string;

      // Payto URI to identify the sender of funds.
      debit_account: string;

      // subject of the incoming payment.
      subject: string;

    }

The anastasis facade
--------------------

The ``anastasis`` facade has the following configuration:


.. ts:def:: AnastasisFacadeConfig

   interface AnastasisFacadeConfig {
     // Bank account and connection that is abstracted over.
     bankAccount: string;
     bankConnection: string;

     currency: string;

     // Corresponds to whether we trust C52, C53 or C54 (SEPA ICT)
     // for incoming transfers.
     reserveTransferLevel: "statement" | "report" | "notification";
   }

The taler-wire-gateway facade
-----------------------------

The ``taler-wire-gateway`` facade has the following configuration:


.. ts:def:: TalerWireGatewayFacadeConfig

   interface TalerWireGatewayFacadeConfig {
     // Bank account and connection that is
     // abstracted over.
     bankAccount: string;
     bankConnection: string;

     currency: string;

     // Corresponds to whether we trust C52, C53 or C54 (SEPA ICT)
     // for incoming transfers.
     reserveTransferLevel: "statement" | "report" | "notification";
   }