-
Notifications
You must be signed in to change notification settings - Fork 22
/
patch.diff
1352 lines (1306 loc) · 52.3 KB
/
patch.diff
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
diff --git "a/Vinnusv\303\246\303\260i/Verk\303\276\303\241ttur 3/IST-FUT-TN-FMTH-Working.yaml" "b/Vinnusv\303\246\303\260i/Verk\303\276\303\241ttur 3/IST-FUT-TN-FMTH-Working.yaml"
index fc27d2f..3c700fa 100644
--- "a/Vinnusv\303\246\303\260i/Verk\303\276\303\241ttur 3/IST-FUT-TN-FMTH-Working.yaml"
+++ "b/Vinnusv\303\246\303\260i/Verk\303\276\303\241ttur 3/IST-FUT-TN-FMTH-Working.yaml"
@@ -1,10 +1,11 @@
openapi: 3.0.1
info:
- title: NextGenPSD2 XS2A Framework
- version: "1.3.6_2020-08-14"
+ title: IST WA 310 Domestic payments and deposits
+ version: "2020-08-17"
description: |
# Summary
- The **NextGenPSD2** *Framework Version 1.3.6* (with several errata) offers a modern, open, harmonised and interoperable set of
+ The document extends the NextGenPSD2 XS2A Framework version 1.3.6* (with several errata) offers a modern, open, harmonised and
+ The **NextGenPSD2** *Framework Version 1.3.6* (with several errata) offers a modern, open, harmonised and
Application Programming Interfaces (APIs) as the safest and most efficient way to provide data securely.
The NextGenPSD2 Framework reduces XS2A complexity and costs, addresses the problem of multiple competing standards
in Europe and, aligned with the goals of the Euro Retail Payments Board,
@@ -14,56 +15,57 @@ info:
The possible Approaches are:
* Redirect SCA Approach
* OAuth SCA Approach
+ The following items are not required. Optional for each bank to implement.
* Decoupled SCA Approach
* Embedded SCA Approach without SCA method
* Embedded SCA Approach with only one SCA method available
* Embedded SCA Approach with Selection of a SCA method
- Not every message defined in this API definition is necessary for all approaches.
- Furthermore this API definition does not differ between methods which are mandatory, conditional, or optional.
- Therefore for a particular implementation of a Berlin Group PSD2 compliant API it is only necessary to support
+ Not every message defined in this API definition is necessary for all approaches.
+ Furthermore this API definition does not differ between methods which are mandatory, conditional, or optional
+ Therefore for a particular implementation of a Berlin Group PSD2 compliant API it is only necessary to support
a certain subset of the methods defined in this API definition.
- **Please have a look at the implementation guidelines if you are not sure
+ **Please have a look at the implementation guidelines if you are not sure
which message has to be used for the approach you are going to use.**
-
+
## Some General Remarks Related to this version of the OpenAPI Specification:
- * **This API definition is based on the Implementation Guidelines of the Berlin Group PSD2 API.**
- It is not a replacement in any sense.
+ * **This API definition is based on the Implementation Guidelines of the Berlin Group PSD2 API.**
+ It is not an replacement in any sense.
The main specification is (at the moment) always the Implementation Guidelines of the Berlin Group PSD2 API.
* **This API definition contains the REST-API for requests from the PISP to the ASPSP.**
* **This API definition contains the messages for all different approaches defined in the Implementation Guidelines.**
* According to the OpenAPI-Specification [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md]
-
+
"If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored."
-
+
The element "Accept" will not be defined in this file at any place.
-
+
The elements "Content-Type" and "Authorization" are implicitly defined by the OpenApi tags "content" and "security".
-
- * There are several predefined types which might occur in payment initiation messages,
+
+ * There are several predefined types which might occur in payment initiation messages,
but are not used in the standard JSON messages in the Implementation Guidelines.
Therefore they are not used in the corresponding messages in this file either.
We added them for the convenience of the user.
If there is a payment product, which needs these fields, one can easily use the predefined types.
But the ASPSP need not to accept them in general.
-
- * **We omit the definition of all standard HTTP header elements (mandatory/optional/conditional)
+
+ * **We omit the definition of all standard HTTP header elements (mandatory/optional/conditional)
except they are mentioned in the Implementation Guidelines.**
Therefore the implementer might add these in his own realisation of a PSD2 comlient API in addition to the elements defined in this file.
-
+
## General Remarks on Data Types
The Berlin Group definition of UTF-8 strings in context of the PSD2 API has to support at least the following characters
a b c d e f g h i j k l m n o p q r s t u v w x y z
-
+
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
-
+
0 1 2 3 4 5 6 7 8 9
-
+
/ - ? : ( ) . , ' +
-
+
Space
@@ -72,20 +74,20 @@ info:
url: https://creativecommons.org/licenses/by/4.0/
#termsOfService: URL for Terms of Service of the API
contact:
- name: The Berlin Group - A European Standards Initiative
- url: https://www.berlin-group.org/
- email: [email protected]
+ name: Stadlarad Islands
+ url: https://www.stadlar.is
+ email: [email protected]
externalDocs:
description: |
Full Documentation of NextGenPSD2 Access to Account Interoperability Framework
(General Introduction Paper, Operational Rules, Implementation Guidelines)
- url: https://www.berlin-group.org/nextgenpsd2-downloads
+ url: https://github.com/stadlar/IST-FUT-FMTH/tree/master/Vinnusv%C3%A6%C3%B0i/Stu%C3%B0ningsefni/Berlin-group/v.1.3.6
servers:
- - url: https://api.testbank.com/psd2
+ - url: https://api-psd2.openbanking.is
description: PSD2 server
- - url: https://test-api.testbank.com/psd2
+ - url: https://test-api-psd2.openbanking.is
description: Optional PSD2 test server
paths:
@@ -409,6 +411,92 @@ paths:
$ref: "#/components/responses/SERVICE_UNAVAILABLE_503_PIS"
+ /v1/{payment-service}/{payment-product}/info/{Query-X-Request-ID}:
+
+ get:
+ summary: Payment id info request
+ description:
+ The response of any payment initiation request includes the attribute 'paymentId' that is a
+ unique number to identify the payment initiation request. The attribute 'paymentId' is then
+ used to get information about the payment initiation request or cancel the request if the
+ corresponding banks have not yet started processing the request. In the case of any communication
+ problems when payment initiation request is sent and the response gets lost, the get payment id
+ request can be used to lookup the 'paymentId' from the x-request-id header value.
+
+ operationId: getPaymentId
+ tags:
+ - Payment Initiation Service (PIS)
+
+ security:
+ #####################################################
+ # REMARKS ON SECURITY IN THIS OPENAPI FILE
+ #In this file only the basic security element to transport
+ # the bearer token of an an OAuth2 process, which has to
+ # be included inthe HTTP header ist described.
+ #
+ # WARNING:
+ # If you want to use this file for a productive implementation,
+ # it is recommandes to adjust the security schemes according to
+ # your system enviroments and security policies.
+ #####################################################
+ - {}
+ - BearerAuthOAuth: []
+
+ parameters:
+ #path
+ - $ref: "#/components/parameters/paymentService"
+ - $ref: "#/components/parameters/paymentProduct"
+ - $ref: "#/components/parameters/Query-X-Request-ID"
+ #query # NO QUERY PARAMETER
+ #header
+ #common header parameter
+ - $ref: "#/components/parameters/X-Request-ID"
+ #header to support the signature function
+ - $ref: "#/components/parameters/Digest"
+ - $ref: "#/components/parameters/Signature"
+ - $ref: "#/components/parameters/TPP-Signature-Certificate"
+ #optional additional PSU Information in header
+ - $ref: "#/components/parameters/PSU-IP-Address_optional"
+ - $ref: "#/components/parameters/PSU-IP-Port"
+ - $ref: "#/components/parameters/PSU-Accept"
+ - $ref: "#/components/parameters/PSU-Accept-Charset"
+ - $ref: "#/components/parameters/PSU-Accept-Encoding"
+ - $ref: "#/components/parameters/PSU-Accept-Language"
+ - $ref: "#/components/parameters/PSU-User-Agent"
+ - $ref: "#/components/parameters/PSU-Http-Method"
+ - $ref: "#/components/parameters/PSU-Device-ID"
+ - $ref: "#/components/parameters/PSU-Geo-Location"
+ #NO REQUEST BODY
+
+ responses:
+ '200':
+ $ref: "#/components/responses/OK_200_PaymentId"
+
+ '400':
+ $ref: "#/components/responses/BAD_REQUEST_400_PIS"
+ '401':
+ $ref: "#/components/responses/UNAUTHORIZED_401_PIS"
+ '403':
+ $ref: "#/components/responses/FORBIDDEN_403_PIS"
+ '404':
+ $ref: "#/components/responses/NOT_FOUND_404_PIS"
+ '405':
+ $ref: "#/components/responses/METHOD_NOT_ALLOWED_405_PIS"
+ '406':
+ $ref: "#/components/responses/NOT_ACCEPTABLE_406_PIS"
+ '408':
+ $ref: "#/components/responses/REQUEST_TIMEOUT_408_PIS"
+ '409':
+ $ref: "#/components/responses/CONFLICT_409_PIS"
+ '415':
+ $ref: "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS"
+ '429':
+ $ref: "#/components/responses/TOO_MANY_REQUESTS_429_PIS"
+ '500':
+ $ref: "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS"
+ '503':
+ $ref: "#/components/responses/SERVICE_UNAVAILABLE_503_PIS"
+
/v1/{payment-service}/{payment-product}/{paymentId}/status:
get:
@@ -1418,6 +1506,7 @@ paths:
#path # NO PATH PARAMETER
#query
- $ref: "#/components/parameters/withBalanceQuery"
+ - $ref: "#/components/parameters/withCreditLimitQuery"
#header
#common header parameter
- $ref: "#/components/parameters/X-Request-ID"
@@ -1510,6 +1599,7 @@ paths:
- $ref: "#/components/parameters/accountId"
#query
- $ref: "#/components/parameters/withBalanceQuery"
+ - $ref: "#/components/parameters/withCreditLimitQuery"
#header
#common header parameter
- $ref: "#/components/parameters/X-Request-ID"
@@ -2180,6 +2270,359 @@ paths:
# Consents
#####################################################
+ #####################################################
+ # Card Information Service
+ #####################################################
+
+ /v1/cards:
+
+ get:
+ summary: Read a list of cards
+ description: |
+ Reads a list of cards with additional information, e.g. balance information.
+ It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.
+ The addressed list of cards depends then on the PSU ID and the stored consent addressed by consentId,
+ respectively the OAuth2 access token.
+ operationId: getCard
+ tags:
+ - Account Information Service (AIS)
+
+ security:
+ #####################################################
+ # REMARKS ON SECURITY IN THIS OPENAPI FILE
+ # In this file only the basic security element to transport
+ # the bearer token of an OAuth2 process, which has to
+ # be included in the HTTP header is described.
+ #
+ # WARNING:
+ # If you want to use this file for a productive implementation,
+ # it is recommended to adjust the security schemes according to
+ # your system environments and security policies.
+ #####################################################
+ - {}
+ - BearerAuthOAuth: []
+
+ parameters:
+ #path # NO PATH PARAMETER
+ #query # NO QUERY PARAMETER
+ #header
+ #common header parameter
+ - $ref: "#/components/parameters/X-Request-ID"
+ #header to support the signature function
+ - $ref: "#/components/parameters/Digest"
+ - $ref: "#/components/parameters/Signature"
+ - $ref: "#/components/parameters/TPP-Signature-Certificate"
+ #method specific header elements
+ - $ref: "#/components/parameters/consentId_HEADER_mandatory"
+ #conditional elemention for AIS
+ - $ref: "#/components/parameters/PSU-IP-Address_conditionalForAis"
+ #optional additional PSU Information in header
+ - $ref: "#/components/parameters/PSU-IP-Port"
+ - $ref: "#/components/parameters/PSU-Accept"
+ - $ref: "#/components/parameters/PSU-Accept-Charset"
+ - $ref: "#/components/parameters/PSU-Accept-Encoding"
+ - $ref: "#/components/parameters/PSU-Accept-Language"
+ - $ref: "#/components/parameters/PSU-User-Agent"
+ - $ref: "#/components/parameters/PSU-Http-Method"
+ - $ref: "#/components/parameters/PSU-Device-ID"
+ - $ref: "#/components/parameters/PSU-Geo-Location"
+ #NO REQUEST BODDY
+
+ responses:
+ '200':
+ $ref: "#/components/responses/OK_200_CardList"
+
+ '400':
+ $ref: "#/components/responses/BAD_REQUEST_400_AIS"
+ '401':
+ $ref: "#/components/responses/UNAUTHORIZED_401_AIS"
+ '403':
+ $ref: "#/components/responses/FORBIDDEN_403_AIS"
+ '404':
+ $ref: "#/components/responses/NOT_FOUND_404_AIS"
+ '405':
+ $ref: "#/components/responses/METHOD_NOT_ALLOWED_405_AIS"
+ '406':
+ $ref: "#/components/responses/NOT_ACCEPTABLE_406_AIS"
+ '408':
+ $ref: "#/components/responses/REQUEST_TIMEOUT_408_AIS"
+ '409':
+ $ref: "#/components/responses/CONFLICT_409_AIS"
+ '415':
+ $ref: "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"
+ '429':
+ $ref: "#/components/responses/TOO_MANY_REQUESTS_429_AIS"
+ '500':
+ $ref: "#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"
+ '503':
+ $ref: "#/components/responses/SERVICE_UNAVAILABLE_503_AIS"
+
+ /v1/cards/{card-id}:
+ get:
+ summary: Read details about a card
+ description: |
+ Reads details about a card.
+ It is assumed that a consent of the PSU to this access is already given
+ and stored on the ASPSP system. The addressed details of this account depends
+ then on the stored consent addressed by consentId, respectively the OAuth2
+ access token.
+ operationId: ReadCard
+ tags:
+ - Account Information Service (AIS)
+
+ security:
+ #####################################################
+ # REMARKS ON SECURITY IN THIS OPENAPI FILE
+ # In this file only the basic security element to transport
+ # the bearer token of an OAuth2 process, which has to
+ # be included in the HTTP header is described.
+ #
+ # WARNING:
+ # If you want to use this file for a productive implementation,
+ # it is recommended to adjust the security schemes according to
+ # your system environments and security policies.
+ #####################################################
+ - {}
+ - BearerAuthOAuth: []
+
+ parameters:
+ #path
+ - $ref: "#/components/parameters/accountId"
+ #query # NO QUERY PARAMETER
+ #header
+ #common header parameter
+ - $ref: "#/components/parameters/X-Request-ID"
+ #header to support the signature function
+ - $ref: "#/components/parameters/Digest"
+ - $ref: "#/components/parameters/Signature"
+ - $ref: "#/components/parameters/TPP-Signature-Certificate"
+ #method specific header elements
+ - $ref: "#/components/parameters/consentId_HEADER_mandatory"
+ #conditional elemention for AIS
+ - $ref: "#/components/parameters/PSU-IP-Address_conditionalForAis"
+ #optional additional PSU Information in header
+ - $ref: "#/components/parameters/PSU-IP-Port"
+ - $ref: "#/components/parameters/PSU-Accept"
+ - $ref: "#/components/parameters/PSU-Accept-Charset"
+ - $ref: "#/components/parameters/PSU-Accept-Encoding"
+ - $ref: "#/components/parameters/PSU-Accept-Language"
+ - $ref: "#/components/parameters/PSU-User-Agent"
+ - $ref: "#/components/parameters/PSU-Http-Method"
+ - $ref: "#/components/parameters/PSU-Device-ID"
+ - $ref: "#/components/parameters/PSU-Geo-Location"
+ #NO REQUEST BODDY
+
+ responses:
+ '200':
+ $ref: "#/components/responses/OK_200_CardAccountDetails"
+
+ '400':
+ $ref: "#/components/responses/BAD_REQUEST_400_AIS"
+ '401':
+ $ref: "#/components/responses/UNAUTHORIZED_401_AIS"
+ '403':
+ $ref: "#/components/responses/FORBIDDEN_403_AIS"
+ '404':
+ $ref: "#/components/responses/NOT_FOUND_404_AIS"
+ '405':
+ $ref: "#/components/responses/METHOD_NOT_ALLOWED_405_AIS"
+ '406':
+ $ref: "#/components/responses/NOT_ACCEPTABLE_406_AIS"
+ '408':
+ $ref: "#/components/responses/REQUEST_TIMEOUT_408_AIS"
+ '409':
+ $ref: "#/components/responses/CONFLICT_409_AIS"
+ '415':
+ $ref: "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"
+ '429':
+ $ref: "#/components/responses/TOO_MANY_REQUESTS_429_AIS"
+ '500':
+ $ref: "#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"
+ '503':
+ $ref: "#/components/responses/SERVICE_UNAVAILABLE_503_AIS"
+
+
+ /v1/cards/{card-id}/balances:
+ get:
+ summary: Read card balances
+ description: |
+ Reads balance data from a given card account addressed by
+ "card-id".
+
+ Remark: This account-id can be a tokenised identification due
+ to data protection reason since the path information might be
+ logged on intermediary servers within the ASPSP sphere.
+ This account-id then can be retrieved by the
+ "Get card list" call.
+
+ operationId: getCardBalances
+ tags:
+ - Account Information Service (AIS)
+
+ security:
+ #####################################################
+ # REMARKS ON SECURITY IN THIS OPENAPI FILE
+ # In this file only the basic security element to transport
+ # the bearer token of an OAuth2 process, which has to
+ # be included in the HTTP header is described.
+ #
+ # WARNING:
+ # If you want to use this file for a productive implementation,
+ # it is recommended to adjust the security schemes according to
+ # your system environments and security policies.
+ #####################################################
+ - {}
+ - BearerAuthOAuth: []
+
+ parameters:
+ #path
+ - $ref: "#/components/parameters/accountId"
+ #query # NO QUERY PARAMETER
+ #header
+ #common header parameter
+ - $ref: "#/components/parameters/X-Request-ID"
+ #header to support the signature function
+ - $ref: "#/components/parameters/Digest"
+ - $ref: "#/components/parameters/Signature"
+ - $ref: "#/components/parameters/TPP-Signature-Certificate"
+ #method specific header elements
+ - $ref: "#/components/parameters/consentId_HEADER_mandatory"
+ #conditional elemention for AIS
+ - $ref: "#/components/parameters/PSU-IP-Address_conditionalForAis"
+ #optional additional PSU Information in header
+ - $ref: "#/components/parameters/PSU-IP-Port"
+ - $ref: "#/components/parameters/PSU-Accept"
+ - $ref: "#/components/parameters/PSU-Accept-Charset"
+ - $ref: "#/components/parameters/PSU-Accept-Encoding"
+ - $ref: "#/components/parameters/PSU-Accept-Language"
+ - $ref: "#/components/parameters/PSU-User-Agent"
+ - $ref: "#/components/parameters/PSU-Http-Method"
+ - $ref: "#/components/parameters/PSU-Device-ID"
+ - $ref: "#/components/parameters/PSU-Geo-Location"
+ #NO REQUEST BODDY
+
+ responses:
+ '200':
+ $ref: "#/components/responses/OK_200_CardBalances"
+
+ '400':
+ $ref: "#/components/responses/BAD_REQUEST_400_AIS"
+ '401':
+ $ref: "#/components/responses/UNAUTHORIZED_401_AIS"
+ '403':
+ $ref: "#/components/responses/FORBIDDEN_403_AIS"
+ '404':
+ $ref: "#/components/responses/NOT_FOUND_404_AIS"
+ '405':
+ $ref: "#/components/responses/METHOD_NOT_ALLOWED_405_AIS"
+ '406':
+ $ref: "#/components/responses/NOT_ACCEPTABLE_406_AIS"
+ '408':
+ $ref: "#/components/responses/REQUEST_TIMEOUT_408_AIS"
+ '409':
+ $ref: "#/components/responses/CONFLICT_409_AIS"
+ '415':
+ $ref: "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"
+ '429':
+ $ref: "#/components/responses/TOO_MANY_REQUESTS_429_AIS"
+ '500':
+ $ref: "#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"
+ '503':
+ $ref: "#/components/responses/SERVICE_UNAVAILABLE_503_AIS"
+
+
+
+ /v1/cards/{card-id}/transactions:
+ get:
+ summary: Read transaction list of a card
+ description: |
+ Reads data from a given card addressed by "card-id".
+ operationId: getCardTransactionList
+ tags:
+ - Account Information Service (AIS)
+
+ security:
+ #####################################################
+ # REMARKS ON SECURITY IN THIS OPENAPI FILE
+ # In this file only the basic security element to transport
+ # the bearer token of an OAuth2 process, which has to
+ # be included in the HTTP header is described.
+ #
+ # WARNING:
+ # If you want to use this file for a productive implementation,
+ # it is recommended to adjust the security schemes according to
+ # your system environments and security policies.
+ #####################################################
+ - {}
+ - BearerAuthOAuth: []
+
+ parameters:
+ #path
+ - $ref: "#/components/parameters/accountId"
+ #query
+ - $ref: "#/components/parameters/dateFrom"
+ - $ref: "#/components/parameters/dateTo"
+ - $ref: "#/components/parameters/entryReferenceFrom"
+ - $ref: "#/components/parameters/bookingStatus"
+ - $ref: "#/components/parameters/deltaList"
+ - $ref: "#/components/parameters/withBalanceQuery"
+ #header
+ #common header parameter
+ - $ref: "#/components/parameters/X-Request-ID"
+ #header to support the signature function
+ - $ref: "#/components/parameters/Digest"
+ - $ref: "#/components/parameters/Signature"
+ - $ref: "#/components/parameters/TPP-Signature-Certificate"
+ #method specific header elements
+ - $ref: "#/components/parameters/consentId_HEADER_mandatory"
+ #- $ref: "#/components/parameters/Accept" #Can not defined in Open API. See general comments in the description attached to the top level of the file.
+ #conditional elemention for AIS
+ - $ref: "#/components/parameters/PSU-IP-Address_conditionalForAis"
+ #optional additional PSU Information in header
+ - $ref: "#/components/parameters/PSU-IP-Port"
+ - $ref: "#/components/parameters/PSU-Accept"
+ - $ref: "#/components/parameters/PSU-Accept-Charset"
+ - $ref: "#/components/parameters/PSU-Accept-Encoding"
+ - $ref: "#/components/parameters/PSU-Accept-Language"
+ - $ref: "#/components/parameters/PSU-User-Agent"
+ - $ref: "#/components/parameters/PSU-Http-Method"
+ - $ref: "#/components/parameters/PSU-Device-ID"
+ - $ref: "#/components/parameters/PSU-Geo-Location"
+ #NO REQUEST BODY
+
+ responses:
+ '200':
+ $ref: "#/components/responses/OK_200_CardAccountsTransactions"
+
+ '400':
+ $ref: "#/components/responses/BAD_REQUEST_400_AIS"
+ '401':
+ $ref: "#/components/responses/UNAUTHORIZED_401_AIS"
+ '403':
+ $ref: "#/components/responses/FORBIDDEN_403_AIS"
+ '404':
+ $ref: "#/components/responses/NOT_FOUND_404_AIS"
+ '405':
+ $ref: "#/components/responses/METHOD_NOT_ALLOWED_405_AIS"
+ '406':
+ $ref: "#/components/responses/NOT_ACCEPTABLE_406_AIS"
+ '408':
+ $ref: "#/components/responses/REQUEST_TIMEOUT_408_AIS"
+ '409':
+ $ref: "#/components/responses/CONFLICT_409_AIS"
+ '415':
+ $ref: "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"
+ '429':
+ $ref: "#/components/responses/TOO_MANY_REQUESTS_429_AIS"
+ '500':
+ $ref: "#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"
+ '503':
+ $ref: "#/components/responses/SERVICE_UNAVAILABLE_503_AIS"
+
+ #####################################################
+ # Consents Service
+ #####################################################
+
/v1/consents:
post:
summary: Create consent
@@ -4583,16 +5026,77 @@ components:
description: Product name of the bank for this account, proprietary definition.
type: string
maxLength: 35
- cashAccountType:
- $ref: "#/components/schemas/cashAccountType"
+ cashAccountType:
+ $ref: "#/components/schemas/cashAccountType"
+ status:
+ $ref: "#/components/schemas/accountStatus"
+ bic:
+ $ref: "#/components/schemas/bicfi"
+ linkedAccounts:
+ description: Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.
+ type: string
+ maxLength: 70
+ usage:
+ description: |
+ Specifies the usage of the account:
+ * PRIV: private personal account
+ * ORGA: professional account
+ type: string
+ maxLength: 4
+ enum:
+ - "PRIV"
+ - "ORGA"
+ details:
+ description: |
+ Specifications that might be provided by the ASPSP:
+ - characteristics of the account
+ - characteristics of the relevant card
+ type: string
+ maxLength: 500
+ creditLimit:
+ $ref: "#/components/schemas/amount"
+ balances:
+ $ref: "#/components/schemas/balanceList"
+ _links:
+ $ref: "#/components/schemas/_linksAccountDetails"
+ ownerName:
+ $ref: "#/components/schemas/ownerName"
+
+
+ cardAccountDetails:
+ description: |
+ Card account details.
+ type: object
+ required:
+ - maskedPan
+ - currency
+ properties:
+ resourceId:
+ description: |
+ This is the data element to be used in the path when retrieving data from a dedicated account.
+ This shall be filled, if addressable resource are created by the ASPSP on the /card-accounts endpoint.
+ type: string
+ maskedPan:
+ $ref: "#/components/schemas/maskedPan"
+ currency:
+ $ref: "#/components/schemas/currencyCode"
+ ownerName:
+ $ref: "#/components/schemas/ownerName"
+ name:
+ description: |
+ Name of the account, as assigned by the ASPSP,
+ in agreement with the account owner in order to provide an additional means of identification of the account.
+ type: string
+ maxLength: 70
+ displayName:
+ $ref: "#/components/schemas/displayName"
+ product:
+ description: |
+ Product Name of the Bank for this account, proprietary definition.
+ type: string
+ maxLength: 35
status:
$ref: "#/components/schemas/accountStatus"
- bic:
- $ref: "#/components/schemas/bicfi"
- linkedAccounts:
- description: Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.
- type: string
- maxLength: 70
usage:
description: |
Specifies the usage of the account:
@@ -4610,17 +5114,17 @@ components:
- characteristics of the relevant card
type: string
maxLength: 500
+ creditLimit:
+ $ref: "#/components/schemas/amount"
balances:
$ref: "#/components/schemas/balanceList"
_links:
$ref: "#/components/schemas/_linksAccountDetails"
- ownerName:
- $ref: "#/components/schemas/ownerName"
- cardAccountDetails:
+ cardDetails:
description: |
- Card account details.
+ Card details.
type: object
required:
- maskedPan
@@ -4629,7 +5133,7 @@ components:
resourceId:
description: |
This is the data element to be used in the path when retrieving data from a dedicated account.
- This shall be filled, if addressable resource are created by the ASPSP on the /card-accounts endpoint.
+ This shall be filled, if addressable resource are created by the ASPSP on the /cards endpoint.
type: string
maskedPan:
$ref: "#/components/schemas/maskedPan"
@@ -4637,9 +5141,19 @@ components:
$ref: "#/components/schemas/currencyCode"
ownerName:
$ref: "#/components/schemas/ownerName"
+ expDate:
+ $ref: "#/components/schemas/expDate"
+ issueDate:
+ $ref: "#/components/schemas/issueDate"
+ cardholderName:
+ $ref: "#/components/schemas/cardholderName"
+ panId:
+ $ref: "#/components/schemas/panId"
+ bank:
+ $ref: "#/components/schemas/bank"
name:
description: |
- Name of the account, as assigned by the ASPSP,
+ Name of the account, as assigned by the ASPSP,
in agreement with the account owner in order to provide an additional means of identification of the account.
type: string
maxLength: 70
@@ -4703,6 +5217,19 @@ components:
$ref: "#/components/schemas/cardAccountDetails"
+ cardList:
+ description: |
+ List of card accounts with details.
+ type: object
+ required:
+ - cardAccounts
+ properties:
+ cardAccounts:
+ type: array
+ items:
+ $ref: "#/components/schemas/cardDetails"
+
+
accountReport:
description: |
JSON based account report.
@@ -4763,6 +5290,11 @@ components:
properties:
transactionId:
$ref: "#/components/schemas/transactionId"
+ transactionTimestamp:
+ description: |
+ Execution datetime of the record
+ type: string
+ format: date-time
entryReference:
$ref: "#/components/schemas/entryReference"
endToEndId:
@@ -4797,15 +5329,22 @@ components:
$ref: "#/components/schemas/bicfi"
ultimateCreditor:
$ref: "#/components/schemas/ultimateCreditor"
+ ultimateCreditorId:
+ $ref: "#/components/schemas/ultimateCreditorId"
debtorName:
$ref: "#/components/schemas/debtorName"
+ debtorId:
+ $ref: "#/components/schemas/debtorId"
debtorAccount:
$ref: "#/components/schemas/accountReference"
debtorAgent:
$ref: "#/components/schemas/bicfi"
ultimateDebtor:
$ref: "#/components/schemas/ultimateDebtor"
- remittanceInformationUnstructured:
+ ultimateDebtorId:
+ $ref: "#/components/schemas/ultimateDebtorId"
+
+ remittanceInformationUnstructured:
$ref: "#/components/schemas/remittanceInformationUnstructured"
remittanceInformationUnstructuredArray:
$ref: "#/components/schemas/remittanceInformationUnstructuredArray"
@@ -4819,6 +5358,9 @@ components:
$ref: "#/components/schemas/additionalInformationStructured"
purposeCode:
$ref: "#/components/schemas/purposeCode"
+ icelandicPurpose:
+ $ref: "#/components/schemas/icelandicPurpose"
+
bankTransactionCode:
$ref: "#/components/schemas/bankTransactionCode"
proprietaryBankTransactionCode:
@@ -4874,6 +5416,8 @@ components:
transactionDetails:
type: string
maxLength: 140
+ posEntryMode:
+ $ref: "#/components/schemas/posEntryMode"
invoiced:
type: boolean
proprietaryBankTransactionCode:
@@ -5034,6 +5578,33 @@ components:
example: "FR7612345987650123456789014"
+ expDate:
+ type: string
+ description: Experation date for a card in the form mm/yy.
+ pattern: "missing"
+ example: "missing"
+
+ issueDate:
+ type: string
+ format: date
+ description: Issuing date for a card.
+ pattern: "missing"
+ example: "missing"
+
+ cardholderName:
+ type: string
+ description: Experation date for a card.
+
+ panId:
+ type: string
+
+ bank:
+ type: string
+ description: Icelandic bank number.
+ pattern: "missing"
+ example: "missing"
+
+
address:
type: object
required:
@@ -5245,6 +5816,11 @@ components:
$ref: "#/components/schemas/remittanceInformationUnstructured"
example: ["Ref Number Merchant", "Some Other Text"]
+ partialPayment:
+ description: |
+ Payment used to pay claim (Icelandic)
+ type: boolean
+ example: false
additionalInformation:
description: |
@@ -5819,6 +6395,12 @@ components:
maxLength: 70
example: "Ultimate Debtor"
+ ultimateDebtorId:
+ description: Ultimate Debtor Id
+ type: string
+ maxLength: 35
+ example: "Ultimate Debtor Id 1234"
+
debtorId:
description: Debtor Id.
type: string
@@ -5831,6 +6413,12 @@ components:
maxLength: 70
example: "Ultimate Creditor"
+ ultimateCreditorId:
+ description: Ultimate Creditor Id
+ type: string
+ maxLength: 35
+ example: "Ultimate Creditor Id 1234"
+
#####################################################
# Predefined Date and Time Related Formats
#####################################################
@@ -5962,7 +6550,7 @@ components:
- debtorAccount
- instructedAmount
- creditorAccount
- - creditorName
+ # - creditorName
properties:
endToEndIdentification:
type: string
@@ -5974,10 +6562,12 @@ components:
# $ref: "#/components/schemas/debtorName"
debtorAccount:
$ref: "#/components/schemas/accountReference"
-# debtorId: # N.A. for all, but can be used by ASPSP if needed
-# $ref: "#/components/schemas/debtorId"
-# ultimateDebtor: # N.A. for all, but can be used by ASPSP if needed
-# $ref: "#/components/schemas/ultimateDebtor"
+ debtorId: # N.A. for all, but can be used by ASPSP if needed
+ $ref: "#/components/schemas/debtorId"
+ ultimateDebtor: # N.A. for all, but can be used by ASPSP if needed
+ $ref: "#/components/schemas/ultimateDebtor"
+ ultimateDebtorId: # N.A. for all, but can be used by ASPSP if needed
+ $ref: "#/components/schemas/ultimateDebtorId"
instructedAmount:
$ref: "#/components/schemas/amount"
# transactionCurrency: # N.A. for all, but can be used by ASPSP if needed
@@ -5992,16 +6582,20 @@ components:
$ref: "#/components/schemas/creditorAgentName"
creditorName:
$ref: "#/components/schemas/creditorName"
- creditorAddress:
- $ref: "#/components/schemas/address"
+# creditorAddress:
+# $ref: "#/components/schemas/address"
# creditorId: # N.A. for all, but can be used by ASPSP if needed
# description: Identification of Creditors, e.g. a SEPA Creditor ID.
# type: string
# maxLength: 35
# creditorNameAndAddress: # N.A. for all, but can be used by ASPSP if needed
# $ref: "#/components/schemas/creditorNameAndAddress"
-# ultimateCreditor: # N.A. for all, but can be used by ASPSP if needed
-# $ref: "#/components/schemas/ultimateCreditor"
+ ultimateCreditor: # N.A. for all, but can be used by ASPSP if needed
+ $ref: "#/components/schemas/ultimateCreditor"
+ ultimateCreditorId:
+ $ref: "#/components/schemas/ultimateCreditorId"
+ icelandicPurpose:
+ $ref: "#/components/schemas/icelandicPurpose"
# purposeCode: # N.A. for all, but can be used by ASPSP if needed
# $ref: "#/components/schemas/purposeCode"
# chargeBearer: #In some payment product N.A. in some Optional in some conditional
@@ -6010,13 +6604,13 @@ components:
$ref: "#/components/schemas/remittanceInformationUnstructured"
# remittanceInformationUnstructuredArray:
# $ref: "#/components/schemas/remittanceInformationUnstructuredArray"
-# remittanceInformationStructured: # N.A. for all, but can be used by ASPSP if needed
-# $ref: "#/components/schemas/remittanceInformationStructuredMax140"
+ remittanceInformationStructured: # N.A. for all, but can be used by ASPSP if needed
+ $ref: "#/components/schemas/remittanceInformationStructuredMax140"
# remittanceInformationStructuredArray: # N.A. for all, but can be used by ASPSP if needed
# $ref: "#/components/schemas/remittanceInformationStructuredArray"
-# requestedExecutionDate: # N.A. for all, but can be used by ASPSP if needed
-# type: string
-# format: date
+ requestedExecutionDate: # N.A. for all, but can be used by ASPSP if needed
+ type: string
+ format: date
# requestedExecutionTime: # N.A. for all, but can be used by ASPSP if needed
# type: string
# format: date-time
@@ -6095,7 +6689,7 @@ components:
required:
- instructedAmount
- creditorAccount
- - creditorName
+ #- creditorName
properties:
endToEndIdentification:
type: string
@@ -6103,6 +6697,15 @@ components:
# instructionIdentification: # N.A. for all, but can be used by ASPSP if needed
# type: string
# maxLength: 35
+ resourceId:
+ type: string
+ maxLength: 35
+ debtorId: # N.A. for all, but can be used by ASPSP if needed
+ $ref: "#/components/schemas/debtorId"
+ ultimateDebtor: # N.A. for all, but can be used by ASPSP if needed
+ $ref: "#/components/schemas/ultimateDebtor"
+ ultimateDebtorId:
+ $ref: "#/components/schemas/ultimateDebtorId"
# debtorName: # N.A. for all, but can be used by ASPSP if needed
# $ref: "#/components/schemas/debtorName"
# debtorId: # N.A. for all, but can be used by ASPSP if needed
@@ -6117,20 +6720,24 @@ components:
# $ref: "#/components/schemas/paymentExchangeRate"
creditorAccount:
$ref: "#/components/schemas/accountReference"
- creditorAgent:
- $ref: "#/components/schemas/bicfi"
- creditorAgentName:
- $ref: "#/components/schemas/creditorAgentName"
- creditorName:
- $ref: "#/components/schemas/creditorName"
- creditorAddress:
- $ref: "#/components/schemas/address"
+# creditorAgent:
+# $ref: "#/components/schemas/bicfi"
+# creditorAgentName:
+# $ref: "#/components/schemas/creditorAgentName"
+# creditorName:
+# $ref: "#/components/schemas/creditorName"
+# creditorAddress:
+# $ref: "#/components/schemas/address"
# creditorId: # N.A. for all, but can be used by ASPSP if needed
# $ref: "#/components/schemas/creditorId"
# creditorNameAndAddress: # N.A. for all, but can be used by ASPSP if needed
# $ref: "#/components/schemas/creditorNameAndAddress"
-# ultimateCreditor: # N.A. for all, but can be used by ASPSP if needed
-# $ref: "#/components/schemas/ultimateCreditor"
+ ultimateCreditor: # N.A. for all, but can be used by ASPSP if needed
+ $ref: "#/components/schemas/ultimateCreditor"