blob: f75c76e0a241ad9f949d5c119f3e1666d95da1a6 (
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
|
Sandbox API
###########
HTTP API
========
..
Payments.
.. http:post:: /admin/payments
Adds a new payment to the book. Mainly used for testing
purposes.
**Request:**
.. ts:def:: PaymentRequest
interface PaymentRequest {
// IBAN that will receive the payment.
creditorIban: string;
// IBAN that will send the payment.
debitorIban: string;
amount: string;
currency: string;
// subject of the payment.
subject: 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 existing
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 existing
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.
|