blob: df0be59bdd2a41ed29f15c218d544e1f3e0e607b (
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
|
Sandbox API
###########
Entities
========
Customer
...
Bank Account
...
EBICS Subscriber
...
Assumption for sandbox: One customer corresponds to exactly one EBICS subscriber.
HTTP API
========
.. http:post:: /ebicsweb
Submit an EBICS request to the sandbox.
.. http:post:: /admin/customers
Create a new customer. A customer identifies a human that
may own multiple bank accounts.
When creating a customer, one EBICS subscriber is automatically
created for the customer.
In the future, we might add an API to create multiple additional subscribers for
a customer.
When creating a new customer, an ID will be assigned automatically.
.. code-block:: tsref
interface CustomerCreationRequest {
// human-readable name for the customer
name: string;
}
.. http:get:: /admin/customers/:id
Get information about a customer.
.. ts:def:: CustomerInfo
interface CustomerInfo {
ebicsInfo?: CustomerEbicsInfo;
finTsInfo?: CustomerFinTsInfo;
}
.. ts:def:: CustomerEbicsInfo
interface CustomerEbicsInfo {
ebicsHostId: string;
ebicsParterId: string;
ebicsUserId: string;
// Info for the customer's "main subscriber"
subscriberInitializationState: "NEW" | "PARTIALLY_INITIALIZED_INI" | "PARTIALLY_INITIALIZED_HIA" | "READY" | "INITIALIZED";
}
.. ts:def:: CustomerFinTsInfo
// TODO
.. http:post:: /admin/customers/:id/ebics/keyletter
Accept the information from the customer's ("virtual") INI-Letter and HIA-Letter
and change the key's state as required.
.. code-block:: tsref
interface KeyLetterRequest {
partnerId: string;
userId: string;
// FIXME: other fields: see spec and put here
}
|
