-
Notifications
You must be signed in to change notification settings - Fork 0
/
chania-bank-api.yaml
7323 lines (7323 loc) · 263 KB
/
chania-bank-api.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
swagger: '2.0'
info:
version: '1.0'
title: Chania Bank - PSD2 Services v1.0
description: >-
Subset of the Berlin Group's NextGenPSD2 Framework Version 1.3.2 published
on March 28th 2019
termsOfService: ''
contact:
url: 'https://developer.chaniabank.com/api'
email: developer@chaniabank.gr
basePath: /psd2
paths:
'/v1/consents/{consentId}/authorisations':
get:
tags:
- AccountInformationServiceApi
summary: Get Consent Authorisation Sub-Resources Request
description: >-
Return a list of all authorisation subresources IDs which have been
created. This function returns an array of hyperlinks to all generated
authorisation sub-resources.
operationId: GetConsentAuthorisation
consumes: []
produces:
- text/plain
- application/json
- text/json
parameters:
- name: consentId
in: path
description: >-
ID of the corresponding consent object as returned by an Account
Information Consent Request.
required: true
type: string
- name: xRequestID
in: header
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
required: true
type: string
format: uuid
- name: digest
in: header
description: >-
Is contained if and only if the \"Signature\" element is contained
in the header of the request.
required: false
type: string
- name: signature
in: header
description: >-
A signature of the request by the TPP on application level. This
might be mandated by ASPSP.
required: false
type: string
- name: tPPSignatureCertificate
in: header
description: >-
The certificate used for signing the request, in base64 encoding.
Must be contained if a signature is contained.
required: false
type: string
format: byte
- name: pSUIPAddress
in: header
description: >-
The forwarded IP Address header field consists of the corresponding
HTTP request IP Address field between PSU and TPP. It shall be
contained if and only if this request was actively initiated by the
PSU.
required: false
type: string
- name: pSUIPPort
in: header
description: >-
The forwarded IP Port header field consists of the corresponding
HTTP request IP Port field between PSU and TPP, if available.
required: false
type: string
- name: pSUAccept
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptCharset
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptEncoding
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptLanguage
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUUserAgent
in: header
description: >-
The forwarded Agent header field of the HTTP request between PSU and
TPP, if available.
required: false
type: string
- name: pSUHttpMethod
in: header
description: >-
HTTP method used at the PSU ? TPP interface, if available. Valid
values are: * GET * POST * PUT * PATCH * DELETE
required: false
type: string
- name: pSUDeviceID
in: header
description: >-
UUID (Universally Unique Identifier) for a device, which is used by
the PSU, if available. UUID identifies either a device or a device
dependant application installation. In case of an installation
identification this ID need to be unaltered until removal from
device.
required: false
type: string
format: uuid
- name: pSUGeoLocation
in: header
description: >-
The forwarded Geo Location of the corresponding http request between
PSU and TPP if available.
required: false
type: string
pattern: '/GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}/'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Authorisations'
'400':
description: Bad Request
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error400NGAIS'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error401NGAIS'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error403NGAIS'
'404':
description: Not found
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error404NGAIS'
'405':
description: Method Not Allowed
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error405NGAIS'
'406':
description: Not Acceptable
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error406NGAIS'
'408':
description: Request Timeout
'409':
description: Conflict
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error409NGAIS'
'415':
description: Unsupported Media Type
'429':
description: Too Many Requests
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error429NGAIS'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
post:
tags:
- AccountInformationServiceApi
summary: Start the authorisation process for a consent
description: >-
Create an authorisation sub-resource and start the authorisation process
of a consent. The message might in addition transmit authentication and
authorisation related data. his method is iterated n times for a n
times SCA authorisation in a corporate context, each creating an own
authorisation sub-endpoint for the corresponding PSU authorising the
consent. The ASPSP might make the usage of this access method
unnecessary, since the related authorisation resource will be
automatically created by the ASPSP after the submission of the consent
data with the first POST consents call. The start authorisation process
is a process which is needed for creating a new authorisation or
cancellation sub-resource. This applies in the following scenarios:
* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the
preceding Payment Initiation Response that an explicit start of the
authorisation process is needed by the TPP. The
'startAuthorisation' hyperlink can transport more information about data
which needs to be uploaded by using the extended forms. *
'startAuthorisationWithPsuIdentfication', *
'startAuthorisationWithPsuAuthentication' *
'startAuthorisationWithEncryptedPsuAuthentication' *
'startAuthorisationWithAuthentciationMethodSelection' * The related
payment initiation cannot yet be executed since a multilevel SCA is
mandated. * The ASPSP has indicated with an 'startAuthorisation'
hyperlink in the preceding Payment Cancellation Response that an
explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about
data which needs to be uploaded by using the extended forms as
indicated above. * The related payment cancellation request cannot be
applied yet since a multilevel SCA is mandate for executing the
cancellation. * The signing basket needs to be authorised yet.
operationId: StartConsentAuthorisation
consumes:
- application/json-patch+json
- application/json
- text/json
- application/*+json
produces:
- text/plain
- application/json
- text/json
parameters:
- name: xRequestID
in: header
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
required: true
type: string
format: uuid
- name: consentId
in: path
description: >-
ID of the corresponding consent object as returned by an Account
Information Consent Request.
required: true
type: string
- name: body
in: body
description: ''
required: false
schema:
type: string
- name: digest
in: header
description: >-
Is contained if and only if the \"Signature\" element is contained
in the header of the request.
required: false
type: string
- name: signature
in: header
description: >-
A signature of the request by the TPP on application level. This
might be mandated by ASPSP.
required: false
type: string
- name: tPPSignatureCertificate
in: header
description: >-
The certificate used for signing the request, in base64 encoding.
Must be contained if a signature is contained.
required: false
type: string
format: byte
- name: PSU_ID
in: header
description: >-
Client ID of the PSU in the ASPSP client interface. Might be
mandated in the ASPSP's documentation. Is not contained if an OAuth2
based authentication was performed in a pre-step or an OAuth2 based
SCA was performed in an preceding AIS service in the same session.
required: false
type: string
- name: pSUIDType
in: header
description: >-
Type of the PSU-ID, needed in scenarios where PSUs have several
PSU-IDs as access possibility.
required: false
type: string
- name: pSUCorporateID
in: header
description: >-
Might be mandated in the ASPSP's documentation. Only used in a
corporate context.
required: false
type: string
- name: pSUCorporateIDType
in: header
description: >-
Might be mandated in the ASPSP's documentation. Only used in a
corporate context.
required: false
type: string
- name: tPPRedirectPreferred
in: header
description: >-
If it equals \"true\", the TPP prefers a redirect over an embedded
SCA approach. If it equals \"false\", the TPP prefers not to be
redirected for SCA. The ASPSP will then choose between the Embedded
or the Decoupled SCA approach, depending on the choice of the SCA
procedure by the TPP/PSU. If the parameter is not used, the ASPSP
will choose the SCA approach to be applied depending on the SCA
method chosen by the TPP/PSU.
required: false
type: string
- name: tPPRedirectURI
in: header
description: >-
URI of the TPP, where the transaction flow shall be redirected to
after a Redirect. Mandated for the Redirect SCA Approach,
specifically when TPP-Redirect-Preferred equals \"true\". It is
recommended to always use this header field. **Remark for
Future:** This field might be changed to mandatory in the next
version of the specification.
required: false
type: string
- name: tPPNokRedirectURI
in: header
description: >-
If this URI is contained, the TPP is asking to redirect the
transaction flow to this address instead of the TPP-Redirect-URI in
case of a negative result of the redirect SCA method. This might be
ignored by the ASPSP.
required: false
type: string
- name: pSUIPAddress
in: header
description: >-
The forwarded IP Address header field consists of the corresponding
HTTP request IP Address field between PSU and TPP. It shall be
contained if and only if this request was actively initiated by the
PSU.
required: false
type: string
- name: pSUIPPort
in: header
description: >-
The forwarded IP Port header field consists of the corresponding
HTTP request IP Port field between PSU and TPP, if available.
required: false
type: string
- name: pSUAccept
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptCharset
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptEncoding
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptLanguage
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUUserAgent
in: header
description: >-
The forwarded Agent header field of the HTTP request between PSU and
TPP, if available.
required: false
type: string
- name: pSUHttpMethod
in: header
description: >-
HTTP method used at the PSU ? TPP interface, if available. Valid
values are: * GET * POST * PUT * PATCH * DELETE
required: false
type: string
- name: pSUDeviceID
in: header
description: >-
UUID (Universally Unique Identifier) for a device, which is used by
the PSU, if available. UUID identifies either a device or a device
dependant application installation. In case of an installation
identification this ID need to be unaltered until removal from
device.
required: false
type: string
format: uuid
- name: pSUGeoLocation
in: header
description: >-
The forwarded Geo Location of the corresponding http request between
PSU and TPP if available.
required: false
type: string
pattern: '/GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}/'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/ChaniaBank.API.Models.StartScaprocessResponse'
'400':
description: Bad Request
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error400NGAIS'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error401NGAIS'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error403NGAIS'
'404':
description: Not found
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error404NGAIS'
'405':
description: Method Not Allowed
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error405NGAIS'
'406':
description: Not Acceptable
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error406NGAIS'
'408':
description: Request Timeout
'409':
description: Conflict
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error409NGAIS'
'415':
description: Unsupported Media Type
'429':
description: Too Many Requests
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error429NGAIS'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'/v1/consents/{consentId}':
get:
tags:
- AccountInformationServiceApi
summary: Get Consent Request
description: >-
Returns the content of an account information consent object. This is
returning the data for the TPP especially in cases, where the consent
was directly managed between ASPSP and PSU e.g. in a re-direct SCA
Approach.
operationId: GetConsentInformation
consumes: []
produces:
- text/plain
- application/json
- text/json
parameters:
- name: consentId
in: path
description: >-
ID of the corresponding consent object as returned by an Account
Information Consent Request.
required: true
type: string
- name: xRequestID
in: header
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
required: true
type: string
format: uuid
- name: digest
in: header
description: >-
Is contained if and only if the \"Signature\" element is contained
in the header of the request.
required: false
type: string
- name: signature
in: header
description: >-
A signature of the request by the TPP on application level. This
might be mandated by ASPSP.
required: false
type: string
- name: tPPSignatureCertificate
in: header
description: >-
The certificate used for signing the request, in base64 encoding.
Must be contained if a signature is contained.
required: false
type: string
format: byte
- name: pSUIPAddress
in: header
description: >-
The forwarded IP Address header field consists of the corresponding
HTTP request IP Address field between PSU and TPP. It shall be
contained if and only if this request was actively initiated by the
PSU.
required: false
type: string
- name: pSUIPPort
in: header
description: >-
The forwarded IP Port header field consists of the corresponding
HTTP request IP Port field between PSU and TPP, if available.
required: false
type: string
- name: pSUAccept
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptCharset
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptEncoding
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptLanguage
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUUserAgent
in: header
description: >-
The forwarded Agent header field of the HTTP request between PSU and
TPP, if available.
required: false
type: string
- name: pSUHttpMethod
in: header
description: >-
HTTP method used at the PSU ? TPP interface, if available. Valid
values are: * GET * POST * PUT * PATCH * DELETE
required: false
type: string
- name: pSUDeviceID
in: header
description: >-
UUID (Universally Unique Identifier) for a device, which is used by
the PSU, if available. UUID identifies either a device or a device
dependant application installation. In case of an installation
identification this ID need to be unaltered until removal from
device.
required: false
type: string
format: uuid
- name: pSUGeoLocation
in: header
description: >-
The forwarded Geo Location of the corresponding http request between
PSU and TPP if available.
required: false
type: string
pattern: '/GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}/'
responses:
'200':
description: OK
schema:
$ref: >-
#/definitions/ChaniaBank.API.Models.ConsentInformationResponse200Json
'400':
description: Bad Request
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error400NGAIS'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error401NGAIS'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error403NGAIS'
'404':
description: Not found
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error404NGAIS'
'405':
description: Method Not Allowed
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error405NGAIS'
'406':
description: Not Acceptable
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error406NGAIS'
'408':
description: Request Timeout
'409':
description: Conflict
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error409NGAIS'
'415':
description: Unsupported Media Type
'429':
description: Too Many Requests
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error429NGAIS'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'/v1/consents/{consentId}/authorisations/{authorisationId}':
get:
tags:
- AccountInformationServiceApi
summary: Read the SCA status of the consent authorisation.
description: >-
This method returns the SCA status of a consent initiation's
authorisation sub-resource.
operationId: GetConsentScaStatus
consumes: []
produces:
- text/plain
- application/json
- text/json
parameters:
- name: consentId
in: path
description: >-
ID of the corresponding consent object as returned by an Account
Information Consent Request.
required: true
type: string
- name: authorisationId
in: path
description: Resource identification of the related SCA.
required: true
type: string
- name: xRequestID
in: header
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
required: true
type: string
format: uuid
- name: digest
in: header
description: >-
Is contained if and only if the \"Signature\" element is contained
in the header of the request.
required: false
type: string
- name: signature
in: header
description: >-
A signature of the request by the TPP on application level. This
might be mandated by ASPSP.
required: false
type: string
- name: tPPSignatureCertificate
in: header
description: >-
The certificate used for signing the request, in base64 encoding.
Must be contained if a signature is contained.
required: false
type: string
format: byte
- name: pSUIPAddress
in: header
description: >-
The forwarded IP Address header field consists of the corresponding
HTTP request IP Address field between PSU and TPP. It shall be
contained if and only if this request was actively initiated by the
PSU.
required: false
type: string
- name: pSUIPPort
in: header
description: >-
The forwarded IP Port header field consists of the corresponding
HTTP request IP Port field between PSU and TPP, if available.
required: false
type: string
- name: pSUAccept
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptCharset
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptEncoding
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptLanguage
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUUserAgent
in: header
description: >-
The forwarded Agent header field of the HTTP request between PSU and
TPP, if available.
required: false
type: string
- name: pSUHttpMethod
in: header
description: >-
HTTP method used at the PSU ? TPP interface, if available. Valid
values are: * GET * POST * PUT * PATCH * DELETE
required: false
type: string
- name: pSUDeviceID
in: header
description: >-
UUID (Universally Unique Identifier) for a device, which is used by
the PSU, if available. UUID identifies either a device or a device
dependant application installation. In case of an installation
identification this ID need to be unaltered until removal from
device.
required: false
type: string
format: uuid
- name: pSUGeoLocation
in: header
description: >-
The forwarded Geo Location of the corresponding http request between
PSU and TPP if available.
required: false
type: string
pattern: '/GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}/'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ChaniaBank.API.Models.ScaStatusResponse'
'400':
description: Bad Request
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error400NGAIS'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error401NGAIS'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error403NGAIS'
'404':
description: Not found
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error404NGAIS'
'405':
description: Method Not Allowed
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error405NGAIS'
'406':
description: Not Acceptable
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error406NGAIS'
'408':
description: Request Timeout
'409':
description: Conflict
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error409NGAIS'
'415':
description: Unsupported Media Type
'429':
description: Too Many Requests
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error429NGAIS'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
put:
tags:
- AccountInformationServiceApi
summary: Update PSU Data for consents
description: "This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded SCA Approach where needed. \r\n Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication. \r\n This methods updates PSU data on the cancellation authorisation resource if needed. \r\n There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach: \r\n * Redirect SCA Approach: A specific Update PSU Data Request is applicable for \r\n * the selection of authentication methods, before choosing the actual SCA approach. \r\n * Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for \r\n * adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information \r\n Consent Request, or if no OAuth2 access token is used, or * the selection of authentication methods. * Embedded SCA Approach: \r\n The Update PSU Data Request might be used * to add credentials as a first factor authentication data of the PSU and \r\n * to select the authentication method and * transaction authorisation. The SCA Approach might depend on the chosen SCA method. \r\n For that reason, the following possible Update PSU Data request can apply to all SCA approaches: * Select an SCA method in case of several \r\n SCA methods are available for the customer. There are the following request types on this access path: \r\n * Update PSU Identification * Update PSU Authentication * Select PSU Autorization Method \r\n WARNING: This method need a reduced header, therefore many optional elements are not present. \r\n Maybe in a later version the access path will change. * Transaction Authorisation \r\n WARNING: This method need a reduced header, therefore many optional elements are not present. \r\n Maybe in a later version the access path will change."
operationId: UpdateConsentsPsuData
consumes:
- application/json-patch+json
- application/json
- text/json
- application/*+json
produces:
- text/plain
- application/json
- text/json
parameters:
- name: xRequestID
in: header
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
required: true
type: string
format: uuid
- name: consentId
in: path
description: >-
ID of the corresponding consent object as returned by an Account
Information Consent Request.
required: true
type: string
- name: authorisationId
in: path
description: Resource identification of the related SCA.
required: true
type: string
- name: body
in: body
description: ''
required: false
schema:
type: string
- name: digest
in: header
description: >-
Is contained if and only if the \"Signature\" element is contained
in the header of the request.
required: false
type: string
- name: signature
in: header
description: >-
A signature of the request by the TPP on application level. This
might be mandated by ASPSP.
required: false
type: string
- name: tPPSignatureCertificate
in: header
description: >-
The certificate used for signing the request, in base64 encoding.
Must be contained if a signature is contained.
required: false
type: string
format: byte
- name: PSU_ID
in: header
description: >-
Client ID of the PSU in the ASPSP client interface. Might be
mandated in the ASPSP's documentation. Is not contained if an OAuth2
based authentication was performed in a pre-step or an OAuth2 based
SCA was performed in an preceding AIS service in the same session.
required: false
type: string
- name: pSUIDType
in: header
description: >-
Type of the PSU-ID, needed in scenarios where PSUs have several
PSU-IDs as access possibility.
required: false
type: string
- name: pSUCorporateID
in: header
description: >-
Might be mandated in the ASPSP's documentation. Only used in a
corporate context.
required: false
type: string
- name: pSUCorporateIDType
in: header
description: >-
Might be mandated in the ASPSP's documentation. Only used in a
corporate context.
required: false
type: string
- name: pSUIPAddress
in: header
description: >-
The forwarded IP Address header field consists of the corresponding
HTTP request IP Address field between PSU and TPP. It shall be
contained if and only if this request was actively initiated by the
PSU.
required: false
type: string
- name: pSUIPPort
in: header
description: >-
The forwarded IP Port header field consists of the corresponding
HTTP request IP Port field between PSU and TPP, if available.
required: false
type: string
- name: pSUAccept
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptCharset
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptEncoding
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUAcceptLanguage
in: header
description: >-
The forwarded IP Accept header fields consist of the corresponding
HTTP request Accept header fields between PSU and TPP, if available.
required: false
type: string
- name: pSUUserAgent
in: header
description: >-
The forwarded Agent header field of the HTTP request between PSU and
TPP, if available.
required: false
type: string
- name: pSUHttpMethod
in: header
description: >-
HTTP method used at the PSU ? TPP interface, if available. Valid
values are: * GET * POST * PUT * PATCH * DELETE
required: false
type: string
- name: pSUDeviceID
in: header
description: >-
UUID (Universally Unique Identifier) for a device, which is used by
the PSU, if available. UUID identifies either a device or a device
dependant application installation. In case of an installation
identification this ID need to be unaltered until removal from
device.
required: false
type: string
format: uuid
- name: pSUGeoLocation
in: header
description: >-
The forwarded Geo Location of the corresponding http request between
PSU and TPP if available.
required: false
type: string
pattern: '/GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}/'
responses:
'200':
description: OK
'400':
description: Bad Request
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error400NGAIS'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ChaniaBank.API.Models.Error401NGAIS'
'403':
description: Forbidden