summaryrefslogtreecommitdiff
path: root/libeufin/api-sandbox.rst
blob: d1214d522b304403f2ffb9c66f9d6fac218a5773 (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

Sandbox API
###########


HTTP API
========

..
  Payments.


.. http:post:: /admin/payments/camt

  Return the history of one IBAN in Camt.053 format.

  **Request**

   .. code-block:: tsref

     interface CamtParams {

       // IBAN managed by the running Sandbox, for which
       // the Camt.053 response is going to be generated.
       iban: string;
       
       // The Camt type to return.  Only '53' is allowed
       // at this moment.
       type: number;
     }

  **Response**

  The expected Camt.053 document.


.. http:get:: /admin/payments

   Return the list of *all* the payments known by the sandbox.

   **Response**

   .. code-block:: tsref

     interface SandboxPayments {

       // The list of all known payments, regardless
       // of any IBAN involved in them.
       payments: SandboxPayment[];
     }

.. http:post:: /admin/payments

   Adds a new payment to the book.  Mainly used for testing
   purposes.

   **Request:**
   
   One object of type `SandboxPayment`

    .. ts:def:: SandboxPayment

     interface SandboxPayment {

       // IBAN that will receive the payment.
       creditorIban: string;
       // FIXME
       creditorBic: string;
       // FIXME
       creditorName: string;

       // IBAN that will send the payment.
       debitorIban: string;
       // FIXME
       debitorBic: string;
       // FIXME
       debitorName: string;

       amount: string;
       currency: string;

       // subject of the payment.
       subject: string;

       // Whether the payment is credit or debit *for* the
       // account being managed *by* the running sandbox.
       // Can take the values: "CRDT" or "DBIT".
       direction: string;
     }

..
  Host management.

.. 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[];
     }


..
  Subscriber management.

.. 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;

      }

.. 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;

     }

..
  Main EBICS service.

.. http:post:: /ebicsweb

   Serves all the Ebics requests.