-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
6345 lines (6322 loc) · 223 KB
/
openapi.yaml
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
openapi: 3.0.0
info:
title: BANKS/Connect API Reference
description: ''
version: '2.0'
contact: {}
x-konfig-ignore:
potential-incorrect-type: true
servers:
- url: https://banksapi.io
variables: {}
tags:
- name: Auth
- name: Customer Bank Access
- name: Customer Payment
- name: Providers
- name: Customer Bank Access Consent
- name: Customer Bank Access Payment
- description: >-
Legacy endpoints, that will be replaced by the endpoints in 'Customer
Payment'
name: Customer Ueberweisung
- name: Customer Consent
- name: Customer REG/Protect
- name: Customer Bank Access Builder
- name: Customer
- name: Encrypt
paths:
/auth/mgmt/v1/tenants/{tenant-name}/users:
post:
tags:
- Auth
summary: Create User
operationId: Auth_createTenantUser
description: >-
Creates a technical user corresponding (one-to-one) a tenant's user.
Users are needed to use BANKSapi's core features like adding accounts or
performing payments. After creating a user, they're automatically
activated.
parameters:
- $ref: '#/components/parameters/tenant-name'
requestBody:
$ref: '#/components/requestBodies/CreateUser'
responses:
'201':
description: >-
Returns with a location header under which the user data can be
retrieved.
headers:
Location:
schema:
type: string
example: >-
https://banksapi.io/auth/tenants/demo/users/8fb65b0e-9418-412d-9865-b960ef81b43f
deprecated: false
get:
tags:
- Auth
summary: Get Users
operationId: Auth_getActivatedUsers
description: Get all activated users
parameters:
- $ref: '#/components/parameters/tenant-name'
- description: Whether or not to also include inactive users
name: includeInactive
in: query
schema:
type: boolean
example: true
default: false
responses:
'200':
description: Returns an array of User
content:
application/json:
schema:
$ref: '#/components/schemas/AuthGetActivatedUsersResponse'
example:
- userReference: 1c5b33f6-9c4d-11e6-ba80-480fcfb9550f
username: demo-user
deprecated: false
/auth/oauth2/token:
post:
tags:
- Auth
summary: Create Token
operationId: Auth_createToken
security:
- basicAuth: []
description: >-
Creates a client or user token valid for 24 hours. Client tokens are
needed for administrative use cases such as creating users. User tokens
are needed when creating or querying banking accounts.
requestBody:
description: The request body contains form object with following parameters
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateToken'
example:
grant_type: client_credentials
scope: http://banksapi.io/provider/read
required: true
responses:
'200':
description: Returns token object
content:
application/json:
schema:
$ref: '#/components/schemas/Token'
example:
scope: >-
http://banksapi.io/customer/read
http://banksapi.io/customer/modify
tenant: demo
client: demo-client
user: 1fad71ee-6dbf-49c7-9cb2-fff588de011f
additionalData:
username: demouser
validTo: '2021-10-16T10:46:47.000Z'
access_token: 0defaced-1337-d00d-c0de-face8badcafe
token_type: Bearer
'401':
description: >-
The basic authorization header was not sent or the value was
incorrect.
deprecated: false
/auth/mgmt/v1/tenants:
get:
tags:
- Auth
summary: Get Tenants
operationId: Auth_getTenants
description: Get all tenants
responses:
'200':
description: Returns an array of Tenant
content:
application/json:
schema:
$ref: '#/components/schemas/AuthGetTenantsResponse'
example:
- description: A Tenant for demonstration purposes
name: demo
deprecated: false
/auth/mgmt/v1/tenants/{tenant-name}/users/{user-id}:
get:
tags:
- Auth
summary: Get User
operationId: Auth_getActivatedUser
description: This function can be used to retrieve a single activated user.
parameters:
- $ref: '#/components/parameters/tenant-name'
- $ref: '#/components/parameters/user-id'
responses:
'200':
description: Returns a User object
content:
application/json:
schema:
$ref: '#/components/schemas/User'
example:
userReference: 1c5b33f6-9c4d-11e6-ba80-480fcfb9550f
username: demo-user
deprecated: false
delete:
tags:
- Auth
summary: Delete User
operationId: Auth_deleteUser
description: Deletes a single user. The user must be deactivated beforehand.
parameters:
- $ref: '#/components/parameters/tenant-name'
- $ref: '#/components/parameters/user-id'
- description: Reference type of user ID ("id" (default) or "username")
name: reftype
in: query
schema:
type: string
example: username
responses:
'200':
description: Returns HTTP status of 200 (OK)
'405':
description: >-
Returns HTTP status of 405 (Method Not Allowed) if user has not been
deactivated.
put:
tags:
- Auth
summary: Change user details
operationId: Auth_changeUserDetails
description: Changes user details, such as username, first name or last name
parameters:
- $ref: '#/components/parameters/tenant-name'
- $ref: '#/components/parameters/user-id'
- description: Reference type of user ID ("id" (default) or "username")
name: reftype
in: query
schema:
type: string
example: username
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeUserDetails'
example:
username: demouser
firstname: demo
lastname: user
responses:
'200':
description: Change successful
'409':
description: Username already exists
/auth/mgmt/v1/tenants/{tenant-name}/users/{user-id}/deactivate:
put:
tags:
- Auth
summary: Deactivate User
operationId: Auth_deactivateUser
description: Deactivates a single user
parameters:
- $ref: '#/components/parameters/tenant-name'
- $ref: '#/components/parameters/user-id'
- description: Reference type of user ID ("id" (default) or "username")
name: reftype
in: query
schema:
type: string
example: username
responses:
'200':
description: Returns HTTP status of 200 (OK)
deprecated: false
/auth/mgmt/v1/tenants/{tenant-name}/users/{user-id}/reactivate:
post:
tags:
- Auth
summary: Reactivate User
operationId: Auth_reactivateUser
description: Reactivate a single deactivated user
parameters:
- $ref: '#/components/parameters/tenant-name'
- $ref: '#/components/parameters/user-id'
- description: Reference type of user ID ("id" (default) or "username")
name: reftype
in: query
schema:
type: string
example: username
requestBody:
$ref: '#/components/requestBodies/CreateUser'
responses:
'200':
description: Returns HTTP status of 200 (OK)
deprecated: false
/auth/oauth2/revoke:
post:
tags:
- Auth
summary: Revoke Token
operationId: Auth_revokeToken
security:
- basicAuth: []
description: >-
To revoke a token, the user token is sent to the URL
`https://banksapi.io/auth/oauth2/revoke` via a POST request.
requestBody:
description: The request body contains form object with following parameters
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AuthRevokeTokenRequest'
example:
token: 0defaced-1337-d00d-c0de-face8badcafe
required: true
responses:
'200':
description: Returns HTTP status of 200 (OK)
deprecated: false
/auth/oauth2/introspect:
get:
tags:
- Auth
summary: Introspect Token
operationId: Auth_tokenInfo
security: []
description: Returns information about a token
parameters:
- description: The Token to introspect
name: token
in: query
required: true
schema:
type: string
format: uuid
example: 0defaced-1337-d00d-c0de-face8badcafe
responses:
'200':
description: Returns token object
content:
application/json:
schema:
$ref: '#/components/schemas/Token'
example:
scope: >-
http://banksapi.io/customer/read
http://banksapi.io/customer/modify
tenant: demo
client: demo-client
user: CN=Demo User,OU=Personal,DC=banksapi,DC=io
additionalData:
username: demouser
validTo: '2021-10-16T10:46:47.000Z'
access_token: 0defaced-1337-d00d-c0de-face8badcafe
token_type: Bearer
'400':
description: No token was provided.
'401':
description: >-
The basic authorization header was not sent or the value was
incorrect.
'403':
description: The provided token is not valid.
deprecated: false
/encrypt:
put:
tags:
- Encrypt
summary: Encrypt plaintexts
operationId: Encrypt_plaintext
description: >-
Encrypt a given plaintext for the tenant identified by the given bearer
token.
requestBody:
description: Plaintext to encrypt encoded in Base64
content:
application/octet-stream+base64:
schema:
$ref: '#/components/schemas/EncryptPlaintextRequest'
example: aGCZBgX ... 8Fi7xMQ=
required: true
responses:
'200':
description: Ciphertext (encrypted plaintext) encoded in Base64
content:
application/octet-stream+base64:
schema:
$ref: '#/components/schemas/EncryptPlaintextResponse'
example: aGCZBgX ... 8Fi7xMQ=
/providers/v2:
get:
tags:
- Providers
summary: Get Providers
operationId: Providers_getAll
description: Retrieve a list of and information for all providers.
responses:
'200':
description: Returns an array of providers.
content:
application/json:
schema:
$ref: '#/components/schemas/ProvidersGetAllResponse'
example:
- id: 00000000-0000-0000-0000-000000000000
name: Demo Provider
consumerRelevant: true
group: demo
blz: '12345678'
bic: DEMO1234
relations:
- rel: self
href: >-
https://banksapi.io/providers/v2/00000000-0000-0000-0000-000000000000
- rel: logo
href: https://banksapi.io/providers/v2/demo.svg
capabilities:
- KONTEN
- KARTEN
- DEPOTS
channels:
- - GIROKONTO
- - KREDITKARTE
- TAGESGELDKONTO
authenticationInfo:
loginHint: >-
Der Demo Provider bietet drei Zugänge demo1/demo1,
demo2/demo2 und demo3/demo3
fields:
- fieldkey: userid
label: Demo-User
secret: false
hint: demo1, demo2 oder demo3
format: ^.{1,50}$
- fieldkey: pin
label: Demo-Passwort
secret: true
hint: demo1, demo2 oder demo3
format: ^.{1,50}$
deprecated: false
/providers/v2/coredata:
get:
tags:
- Providers
summary: Get Providers core data
operationId: Providers_listCoreData
description: Retrieve a list of core data for all providers.
parameters:
- description: Filter providers by capability
name: capability
in: query
required: false
schema:
type: string
enum:
- KONTEN
- KARTEN
- DEPOTS
- BAUSPAR
responses:
'200':
description: Returns an array of core data for providers.
content:
application/json:
schema:
$ref: '#/components/schemas/ProvidersListCoreDataResponse'
example:
- id: 00000000-0000-0000-0000-000000000000X
name: Demo Provider
group: demo
blz: '12345678'
bic: DEMO1234
logo: https://banksapi.io/providers/v2/demo.svg
deprecated: false
/providers/v2/statistics/jobs:
get:
tags:
- Providers
summary: Get Providers job statistics
operationId: Providers_getJobStatistics
description: >-
Retrieve a list of provider logos with statistical data about the data
jobs. If there were no successful data jobs or no data jobs at all in
the specified time period, no entry is returned for the corresponding
logo.
parameters:
- description: >-
Specifies the number of past days for fetching job statistics. When
used together with "hours", their values are summed. If none of the
parameters are specified, 2 hours are fetched.
name: days
in: query
required: false
schema:
type: integer
format: int32
- description: >-
Specifies the number of past hours for fetching job statistics. When
used together with "days", their values are summed. If none of the
parameters are specified, 2 hours are fetched.
name: hours
in: query
required: false
schema:
type: integer
format: int32
- description: If only EBICS jobs should be considered for the response.
name: ebics
in: query
required: false
schema:
type: boolean
example: false
- description: >-
If only provider logos with at least one job including a strong
customer authentication (SCA) should be considered for the response.
In case of `false` it will not be checked whether there was an SCA
or not.
name: sca
in: query
required: false
schema:
type: boolean
example: false
responses:
'200':
description: Returns a list of job statistics for providers.
content:
application/json:
schema:
$ref: '#/components/schemas/ProvidersGetJobStatisticsResponse'
example:
- logo: demo
latestSuccessDate: '2023-09-20T11:21:02.000Z'
averageDuration: 29962
successRate: 1
- logo: sparkasse
latestSuccessDate: '2023-09-20T11:28:57.000Z'
averageDuration: 54186
successRate: 0.99
deprecated: false
/providers/v2/{provider-id}:
get:
tags:
- Providers
summary: Get Provider
operationId: Providers_getInformation
description: Retrieve information for a specific provider.
parameters:
- $ref: '#/components/parameters/provider-id'
responses:
'200':
description: Returns a single provider object.
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
example:
id: 00000000-0000-0000-0000-000000000000X
name: Demo Provider
consumerRelevant: true
group: demo
blz: '12345678'
bic: DEMO1234
relations:
- rel: self
href: >-
https://banksapi.io/providers/v2/00000000-0000-0000-0000-000000000000
- rel: logo
href: https://banksapi.io/providers/v2/demo.svg
capabilities:
- KONTEN
- KARTEN
- DEPOTS
channels:
- - GIROKONTO
- - KREDITKARTE
- TAGESGELDKONTO
authenticationInfo:
loginHint: >-
Der Demo Provider bietet drei Zugänge demo1/demo1,
demo2/demo2 und demo3/demo3
fields:
- fieldkey: userid
label: Demo-User
secret: false
hint: demo1, demo2 oder demo3
format: ^.{1,50}$
- fieldkey: pin
label: Demo-Passwort
secret: true
hint: demo1, demo2 oder demo3
format: ^.{1,50}$
links:
self:
$ref: '#/components/links/self'
logo:
description: Provider logo in SVG format
'404':
description: >-
If the URL does not point to a provider, you will get the HTTP
status 404 (Not found).
deprecated: false
/providers/v2/{provider-id}/ebics:
get:
tags:
- Providers
summary: Get Provider EBICS Info
operationId: Providers_getEbicsInfo
description: Retrieve EBICS information for a specific provider (if available).
parameters:
- $ref: '#/components/parameters/provider-id'
responses:
'200':
description: Returns an EBICS info object for a specific provider.
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderEbicsInfo'
example:
hostId: HOSTIDXY
hostUrl: https://ebics.bank.com/ebics
'404':
description: >-
If the URL does not point to a provider, you will get the HTTP
status 404 (Not found).
deprecated: false
/customer/v2:
get:
tags:
- Customer
summary: Get Customer
operationId: Customer_getObject
description: >-
Retrieves the customer object for the authenticated user. It is also the
entry point to the deeper functions of the interface.
responses:
'200':
description: Returns customer object of the user.
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
example:
bankzugaenge:
4000fda7-18af-463f-b694-bbafe5d23a48:
messages:
- level: INFO
code: BA3010
message: SCA benötigt
details: Bitte wählen Sie eine SCA-Methode aus
sicherheitsverfahren:
- kodierung: 980
name: mTAN
hinweis: mTAN
- name: SMS_OTP
kodierung: '942'
hinweis: SMS OTP
relations:
- rel: startSCA
href: >-
https://banksapi.io/v2/customer/consent/1345340218050910215PSDDE-BAFIN-152070CO4960JJ
relations:
- rel: self
href: https://banksapi.io/customer/v2
- rel: get_bankzugaenge
href: https://banksapi.io/customer/v2/bankzugaenge
- rel: add_bankzugaenge
href: https://banksapi.io/customer/v2/bankzugaenge
- rel: delete_bankzugaenge
href: https://banksapi.io/customer/v2/bankzugaenge
links:
self:
$ref: '#/components/links/self'
get_bankzugaenge:
$ref: '#/components/links/get_bankzugaenge'
add_bankzugaenge:
$ref: '#/components/links/add_bankzugaenge'
delete_bankzugaenge:
$ref: '#/components/links/delete_bankzugaenge'
delete_regprotect_sessions:
$ref: '#/components/links/delete_regprotect_sessions'
get_contracts:
$ref: '#/components/links/get_contracts'
get_sales_triggers:
$ref: '#/components/links/get_sales_triggers'
get_life_events:
$ref: '#/components/links/get_life_events'
get_life_stages:
$ref: '#/components/links/get_life_stages'
get_cashflow:
$ref: '#/components/links/get_cashflow'
get_credit_check:
$ref: '#/components/links/get_credit_check'
get_disposable_money:
$ref: '#/components/links/get_disposable_money'
get_affinities:
$ref: '#/components/links/get_affinities'
get_credit_attributes:
$ref: '#/components/links/get_credit_attributes'
get_tagging_rules:
$ref: '#/components/links/get_tagging_rules'
delete_tagging_rules:
$ref: '#/components/links/delete_tagging_rules'
add_tagging_rules:
$ref: '#/components/links/add_tagging_rules'
deprecated: false
/customer/v2/bankzugaenge:
post:
tags:
- Customer Bank Access
summary: Add Bank Access
operationId: CustomerBankAccess_addBankAccess
description: Adds a bank access for the given user and set of credentials.
parameters:
- $ref: '#/components/parameters/customer-ip-address'
- $ref: '#/components/parameters/callbackUrl'
- description: >-
If the bank access already exists, regardless of the **background**
update, all revenues and information are retrieved by the provider,
if true
name: refresh
in: query
required: false
schema:
type: boolean
example: false
- $ref: '#/components/parameters/queryTanSettings'
- description: >-
Flag to solely fetch header data of the account without balances and
transactions (e.g. to get the list of selectable bank products). If
this flag is `true` the flag `sync` in the request payload has to be
`false` and no `selectedBankProducts` can be specified.
name: headOnly
in: query
required: false
schema:
type: boolean
example: true
- description: Indicator if transactions older than 90 days should be fetched.
name: maxTransactions
in: query
required: false
schema:
$ref: '#/components/schemas/MaxTransactions'
- description: >-
Flag to solely fetch payment accounts. Other accounts will be
ignored, which can result in fewer SCAs.
name: paymentAccountsOnly
in: query
required: false
schema:
type: boolean
example: true
requestBody:
description: >-
The body contains information about the bank access. REG/Hosting
tenants need to provide credentials in case this is not a
"refresh"-request. In case of a REG/Protect tenant or a
"refresh"-request the value for the access-id-key should be an empty
object.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBankAccess'
example:
815251d6-c062-4f61-bec0-182bc14a48fb:
providerId: 00000000-0000-0000-0000-000000000000
credentials:
userid: mOd2uKYr+2 ... TWOPCAt5zP
pin: Hhnc+aW/eM ... 7F+XRSHasW
sync: true
selectedBankProducts:
- DE00123456789012345679
required: true
responses:
'201':
$ref: '#/components/responses/bankAccessCreated'
'451':
$ref: '#/components/responses/regprotect'
'504':
description: The started request could not be answered in the given time
deprecated: false
get:
tags:
- Customer Bank Access
summary: Get Bank Accesses
operationId: CustomerBankAccess_getAll
description: Retrieves all bank accesses for this user.
responses:
'200':
description: The success response contains an collection of bank accesses.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListOfBankAccesses'
example:
0b7f4783-4c93-4820-8e73-354a0f1c469e:
id: 0b7f4783-4c93-4820-8e73-354a0f1c469e
providerId: 00000000-0000-0000-0000-000000000000
aktualisierungszeitpunkt: '2021-10-15T09:13:44.000Z'
tanMedien:
- name: Mobil
medienklasse: MOBIL
gueltigVon: '2021-10-15T09:13:44.000Z'
gueltigBis: '2021-10-15T09:13:44.000Z'
sicherheitsverfahren:
- kodierung: 1
name: mockTAN
hinweis: Gib eine durch 2 teilbare Zahl ein
- kodierung: 999
name: iTAN
hinweis: Gib die TAN "12" an.
aktivesSicherheitsverfahren:
kodierung: 999
name: iTAN
hinweis: Gib die TAN "12" an.
relations:
- rel: self
href: >-
https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e
- rel: delete_bankzugang
href: >-
https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e
status: VOLLSTAENDIG
bankprodukte:
- id: DE00123456789012345679
status: VOLLSTAENDIG
bezeichnung: Tagesgeldkonto
kategorie: TAGESGELDKONTO
saldo: 27365.56
aktualisierungszeitpunkt: '2021-10-15T09:13:44.000Z'
saldoDatum: '2021-10-15T00:00:00.000Z'
waehrung: EUR
kontonummer: '9012345679'
iban: DE00123456789012345679
bic: XXX12345678
blz: '12345678'
kreditinstitut: Demo Provider
inhaber: Fritz Testmüller
transferSupport: true
relations:
- rel: get_kontoumsaetze
href: >-
https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e/DE00123456789012345679/kontoumsaetze
- rel: initiate_single_transfer
href: >-
https://banksapi.io/customer/v2/payment/single-transfer
- rel: initiate_bulk_transfer
href: >-
https://banksapi.io/customer/v2/payment/bulk-transfer
messages: []
verfuegungsrahmen: 27365.56
verfuegterBetrag: 0
sync: true
4000fda7-18af-463f-b694-bbafe5d23a48:
status: VOLLSTAENDIG
tanMedien:
- gueltigVon: '2016-06-03T17:17:41.000Z'
gueltigBis: '2016-06-03T17:17:41.000Z'
name: Mobil
medienklasse: MOBIL
sicherheitsverfahren:
- kodierung: 2
name: mTAN
hinweis: mTAN
- kodierung: 1
name: Mock-TAN
hinweis: Mock-TAN
aktivesSicherheitsverfahren:
kodierung: 1
name: Mock-TAN
hinweis: Mock-TAN
aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z'
timeout: '2016-12-24T13:37:42.000Z'
messages: []
bankprodukte: []
relations: []
sync: false
'401':
description: >-
The bearer authorization header was not sent or the value was
incorrect.
deprecated: false
delete:
tags:
- Customer Bank Access
summary: Delete All Bank Accesses
operationId: CustomerBankAccess_removeAllBankAccesses
description: Removes all bank accesses of the authenticated user.
parameters:
- $ref: '#/components/parameters/customer-ip-address'
responses:
'200':
description: The HTTP status 200 returns without any further response body.
deprecated: false
/customer/v2/bankzugaenge/{access-id}:
get:
tags:
- Customer Bank Access
summary: Get Bank Access
operationId: CustomerBankAccess_getSpecificBankAccess
description: Retrieves a specific bank access for this user.
parameters:
- $ref: '#/components/parameters/access-id'
responses:
'200':
description: Returns a bank access object
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccess'
example:
status: VOLLSTAENDIG
tanMedien:
- gueltigVon: '2016-06-03T17:17:41.000Z'
gueltigBis: '2016-06-03T17:17:41.000Z'
name: Mobil
medienklasse: MOBIL
sicherheitsverfahren:
- kodierung: 2
name: mTAN
hinweis: mTAN
- kodierung: 1
name: Mock-TAN
hinweis: Mock-TAN
aktivesSicherheitsverfahren:
kodierung: 1
name: Mock-TAN
hinweis: Mock-TAN
aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z'
timeout: '2016-12-24T13:37:42.000Z'
messages: []
bankprodukte: []
relations: []
sync: false
links:
self:
$ref: '#/components/links/self'
delete_bankzugang:
$ref: '#/components/links/delete_bankzugang'
get_issues:
$ref: '#/components/links/get_issues'
get_challenge_pdf:
$ref: '#/components/links/get_challenge_pdf'
set_method:
$ref: '#/components/links/set_method'
set_medium:
$ref: '#/components/links/set_medium'
authenticate:
$ref: '#/components/links/authenticate'
authenticate_decoupled:
$ref: '#/components/links/authenticate_decoupled'
cancel:
$ref: '#/components/links/cancel'
redirect_url:
$ref: '#/components/links/redirect_url'
refresh_bankzugang:
$ref: '#/components/links/refresh_bankzugang'
'504':
description: The started request could not be answered in the given time
deprecated: false
delete:
tags:
- Customer Bank Access
summary: Delete Bank Access
operationId: CustomerBankAccess_deleteBankAccess
description: Deletes a specific bank access.
parameters:
- $ref: '#/components/parameters/access-id'
- $ref: '#/components/parameters/customer-ip-address'
responses:
'200':
description: Returns without any further response body.
'404':
description: >-
The bank access with the given access-id was not found / does not
exist.
deprecated: false
/customer/v2/bankzugaenge/{access-id}/issues:
get:
tags:
- Customer Bank Access
summary: Get Bank Access Issues
operationId: CustomerBankAccess_getIssues
description: Retrieves last known issues for a specific bank access for this user.
parameters:
- $ref: '#/components/parameters/access-id'
responses:
'200':
description: Returns a bank access issues object
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccessIssues'
example:
id: 815251d6-c062-4f61-bec0-182bc14a48fb
providerId: 00000000-0000-0000-0000-000000000000
tanMedien:
- gueltigVon: '2016-06-03T17:17:41.000Z'
gueltigBis: '2016-06-03T17:17:41.000Z'
name: Mobil
medienklasse: MOBIL
sicherheitsverfahren:
- kodierung: 2
name: mTAN
hinweis: mTAN
- kodierung: 1
name: Mock-TAN
hinweis: Mock-TAN
aktivesSicherheitsverfahren:
kodierung: 1
name: Mock-TAN
hinweis: Mock-TAN
challenge:
name: Mock-TAN-Verfahren
content:
instructions: Enter a TAN that is divisible by 2
decoupled: false
redirect: false
aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z'
messages:
- level: INFO
code: BA3010
message: SCA benötigt
details: Bitte wählen Sie eine SCA-Methode aus
relations:
- rel: set_method
href: >-
https://banksapi.io/v2/customer/consent/1345340218050910215PSDDE-BAFIN-152070CO4960JJ
links:
self:
$ref: '#/components/links/self'
delete_bankzugang:
$ref: '#/components/links/delete_bankzugang'