-
Notifications
You must be signed in to change notification settings - Fork 6
/
swiss-ng-api.yaml
14337 lines (12675 loc) · 537 KB
/
swiss-ng-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
openapi: 3.0.1
info:
title: Swiss NextGen Banking API-Framework
version: "1.3.8_2020-12-14 - Swiss edition 1.3.8.1-CH"
x-logo:
url: "https://openbankingproject-ch.github.io/obp-apis/swiss-ng-logo.png"
backgroundColor: "#FFFFFF"
altText: "Swiss OpenBankingProject Logo"
description: |
# Summary
The **Swiss NextGen API** is based on the NextGenPSD2 *Framework Version 1.3.4* of the Berlin Group which offers a modern, open, harmonised and interoperable set of
Application Programming Interfaces (APIs) as the safest and most efficient way to provide data securely.
The NextGen 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,
enables European banking customers to benefit from innovative products and services ('Banking as a Service')
by granting TPPs safe and secure (authenticated and authorised) access to their bank accounts and financial data.
The Swiss edtion refines the message formats specific to Switzerland and defines some matching examples.
The possible Approaches are:
* Redirect SCA Approach
* *(Not recommended by obp.ch community) OAuth SCA Approach*
* *(Not recommended by obp.ch community) Decoupled SCA Approach*
* *(Not recommended by obp.ch community) Embedded SCA Approach without SCA method*
* *(Not recommended by obp.ch community) Embedded SCA Approach with only one SCA method available*
* *(Not recommended by obp.ch community) 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 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
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 API](https://www.berlin-group.org/nextgenpsd2-downloads).**
It is not a replacement in any sense.
The main specification is (at the moment) always the Implementation Guidelines of the Berlin Group 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,
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)
except they are mentioned in the Implementation Guidelines.**
Therefore the implementer might add these in his own realisation of a 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 API have 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
license:
name: Creative Commons Attribution 4.0 International Public License
url: https://creativecommons.org/licenses/by/4.0/
contact:
name: Open Banking Project Switzerland
url: https://www.openbankingproject.ch
email: info@obp.ch
externalDocs:
description: |
Full Documentation of NextGen Access to Account Interoperability Framework
(General Introduction Paper, Operational Rules, Implementation Guidelines)
url: https://github.com/openbankingproject-ch/obp-apis
servers:
- url: https://api.dev.openbankingproject.ch
description: Open Banking Project Switzerland Developer Portal
paths:
#####################################################
# Payment Information Service
#####################################################
/v1/{payment-service}/{payment-product}:
post:
summary: Payment initiation request
description: |
This method is used to initiate a payment at the ASPSP.
## Variants of payment initiation requests
This method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.
There are the following **payment products**:
- Payment products with payment information in *JSON* format:
- ***domestic-swiss-credit-transfers-isr***
- ***domestic-swiss-credit-transfers***
- ***domestic-swiss-credit-transfers-qr***
- ***domestic-swiss-foreign-credit-transfers***
- ***swiss-sepa-credit-transfers***
- ***swiss-cross-border-credit-transfers***
- Payment products with payment information in *SIX pain.001* XML format:
- ***pain.001-sepa-credit-transfers***
- ***pain.001-cross-border-credit-transfers***
- ***pain.001-swiss-six-credit-transfers***
Furthermore the request body depends on the **payment-service**:
* ***payments***: A single payment initiation request.
* ***bulk-payments***: A collection of several payment initiation requests.
In case of a *pain.001* message there are more than one payments contained in the *pain.001 message.
In case of a *JSON* there are several JSON payment blocks contained in a joining list.
* ***periodic-payments***:
Create a standing order initiation resource for recurrent i.e. periodic payments addressable under {paymentId}
with all data relevant for the corresponding payment product and the execution of the standing order contained in a JSON body.
This is the first step in the API to initiate the related recurring/periodic payment.
## Single and mulitilevel SCA Processes
The payment initiation requests are independent from the need of one or multilevel
SCA processing, i.e. independent from the number of authorisations needed for the execution of payments.
But the response messages are specific to either one SCA processing or multilevel SCA processing.
For payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation,
i.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the
response message of a Payment Initation Request for a payment, where multiple authorisations are needed.
Also if any data is needed for the next action, like selecting an SCA method is not supported in the response,
since all starts of the multiple authorisations are fully equal.
In these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.
operationId: initiatePayment
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 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/paymentService"
- $ref: "#/components/parameters/paymentProduct"
#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/PSU-ID"
- $ref: "#/components/parameters/PSU-ID-Type"
- $ref: "#/components/parameters/PSU-Corporate-ID"
- $ref: "#/components/parameters/PSU-Corporate-ID-Type"
- $ref: "#/components/parameters/consentId_HEADER_optional"
- $ref: "#/components/parameters/PSU-IP-Address_mandatory"
- $ref: "#/components/parameters/TPP-Redirect-Preferred"
- $ref: "#/components/parameters/TPP-Redirect-URI"
- $ref: "#/components/parameters/TPP-Nok-Redirect-URI"
- $ref: "#/components/parameters/TPP-Explicit-Authorisation-Preferred"
- $ref: "#/components/parameters/TPP-Rejection-NoFunds-Preferred"
- $ref: "#/components/parameters/TPP-Brand-Logging-Information"
#conditional for extended service lean Push
- $ref: "#/components/parameters/TPP-Notification-URI"
- $ref: "#/components/parameters/TPP-Notification-Content-Preferred"
#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"
requestBody:
$ref: "#/components/requestBodies/paymentInitiation"
responses:
'201':
$ref: "#/components/responses/CREATED_201_PaymentInitiation"
'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}:
get:
summary: Get payment information
description: Returns the content of a payment object
operationId: getPaymentInformation
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 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/paymentService"
- $ref: "#/components/parameters/paymentProduct"
- $ref: "#/components/parameters/paymentId"
#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_PaymentInitiationInformation"
'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"
delete:
summary: Payment cancellation request
description: |
This method initiates the cancellation of a payment.
Depending on the payment-service, the payment-product and the ASPSP's implementation,
this TPP call might be sufficient to cancel a payment.
If an authorisation of the payment cancellation is mandated by the ASPSP,
a corresponding hyperlink will be contained in the response message.
Cancels the addressed payment with resource identification paymentId if applicable to the payment-service, payment-product and received in product related timelines (e.g. before end of business day for scheduled payments of the last business day before the scheduled execution day).
The response to this DELETE command will tell the TPP whether the
* access method was rejected,
* access method was successful, or
* access method is generally applicable, but further authorisation processes are needed.
operationId: cancelPayment
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 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/paymentService"
- $ref: "#/components/parameters/paymentProduct"
- $ref: "#/components/parameters/paymentId"
#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"
- $ref: "#/components/parameters/TPP-Redirect-Preferred"
- $ref: "#/components/parameters/TPP-Nok-Redirect-URI"
- $ref: "#/components/parameters/TPP-Redirect-URI"
- $ref: "#/components/parameters/TPP-Explicit-Authorisation-Preferred"
#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:
'204':
$ref: "#/components/responses/NO_CONTENT_204_PaymentInitiationCancel"
#If the DELETE is sufficient for cancelling the payment
'202':
$ref: "#/components/responses/RECEIVED_202_PaymentInitiationCancel"
#If the DELETE is not sufficient for cancelling the payment since an authorisation of the cancellation by the PSU is needed.
'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_CANC"
'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:
summary: Payment initiation status request
description: Check the transaction status of a payment initiation.
operationId: getPaymentInitiationStatus
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 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/paymentService"
- $ref: "#/components/parameters/paymentProduct"
- $ref: "#/components/parameters/paymentId"
#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_PaymentInitiationStatus"
'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}/authorisations:
post:
summary: Start the authorisation process for a payment initiation
description: |
Create an authorisation sub-resource and start the authorisation process.
The message might in addition transmit authentication and authorisation related data.
This 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 transaction.
The ASPSP might make the usage of this access method unnecessary in case
of only one SCA process needed, since the related authorisation resource
might be automatically created by the ASPSP after the submission of the
payment data with the first POST payments/{payment-product} 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 a '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 a '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: startPaymentAuthorisation
tags:
- Payment Initiation Service (PIS)
- Common Services
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/paymentService"
- $ref: "#/components/parameters/paymentProduct"
- $ref: "#/components/parameters/paymentId"
#query # NO QUERY PARAMETER
#header
#common header parameter
- $ref: "#/components/parameters/X-Request-ID"
#method specific header elements
- $ref: "#/components/parameters/PSU-ID"
- $ref: "#/components/parameters/PSU-ID-Type"
- $ref: "#/components/parameters/PSU-Corporate-ID"
- $ref: "#/components/parameters/PSU-Corporate-ID-Type"
- $ref: "#/components/parameters/TPP-Redirect-Preferred"
- $ref: "#/components/parameters/TPP-Redirect-URI"
- $ref: "#/components/parameters/TPP-Nok-Redirect-URI"
#conditional for extended service lean Push
- $ref: "#/components/parameters/TPP-Notification-URI"
- $ref: "#/components/parameters/TPP-Notification-Content-Preferred"
#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"
requestBody:
content:
application/json:
schema:
oneOf: #Different Authorisation Bodies
- {}
- $ref: "#/components/schemas/updatePsuAuthentication"
- $ref: "#/components/schemas/selectPsuAuthenticationMethod"
- $ref: "#/components/schemas/transactionAuthorisation"
responses:
'201':
$ref: "#/components/responses/CREATED_201_StartScaProcess"
'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"
get:
summary: Get payment initiation authorisation sub-resources request
description: |
Read 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: getPaymentInitiationAuthorisation
tags:
- Payment Initiation Service (PIS)
- Common Services
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/paymentService"
- $ref: "#/components/parameters/paymentProduct"
- $ref: "#/components/parameters/paymentId"
#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_Authorisations"
'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}/authorisations/{authorisationId}:
get:
summary: Read the SCA status of the payment authorisation
description: |
This method returns the SCA status of a payment initiation's authorisation sub-resource.
operationId: getPaymentInitiationScaStatus
tags:
- Payment Initiation Service (PIS)
- Common Services
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/paymentService"
- $ref: "#/components/parameters/paymentProduct"
- $ref: "#/components/parameters/paymentId"
- $ref: "#/components/parameters/authorisationId"
#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_ScaStatus"
'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"
put:
summary: Update PSU data for payment initiation
description: |
This methods updates PSU data on the authorisation resource if needed.
It may authorise a payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
the authentication method and a non-SCA PSU authentication.
There are several possible update PSU data requests in the context of payment initiation services needed,
which depends on the SCA approach:
* Redirect SCA Approach:
A specific update PSU data request is applicable for
* the selection of authentication methods, before choosing the actual SCA approach.
* Decoupled SCA Approach:
A specific update PSU data request is only applicable for
* adding the PSU identification, if not provided yet in the payment initiation request or the account information consent request, or if no OAuth2 access token is used, or
* the selection of authentication methods.
* Embedded SCA Approach:
The Update PSU Data request might be used
* to add credentials as a first factor authentication data of the PSU and
* to select the authentication method and
* transaction authorisation.
The SCA Approach might depend on the chosen SCA method.
For that reason, the following possible Update PSU data request can apply to all SCA approaches:
* Select an SCA method in case of several SCA methods are available for the customer.
There are the following request types on this access path:
* Update PSU identification
* Update PSU authentication
* Select PSU autorization method
WARNING: This method needs a reduced header,
therefore many optional elements are not present.
Maybe in a later version the access path will change.
* Transaction authorisation
WARNING: This method needs a reduced header,
therefore many optional elements are not present.
Maybe in a later version the access path will change.
operationId: updatePaymentPsuData
tags:
- Payment Initiation Service (PIS)
- Common Services
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/paymentService"
- $ref: "#/components/parameters/paymentProduct"
- $ref: "#/components/parameters/paymentId"
- $ref: "#/components/parameters/authorisationId"
#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 # Not always allowed depending on the kind of update which is ask for
- $ref: "#/components/parameters/PSU-ID"
- $ref: "#/components/parameters/PSU-ID-Type"
- $ref: "#/components/parameters/PSU-Corporate-ID"
- $ref: "#/components/parameters/PSU-Corporate-ID-Type"
#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"
requestBody:
content:
application/json:
schema:
oneOf: #Different authorisation bodies
- {}
- $ref: "#/components/schemas/updatePsuAuthentication"
- $ref: "#/components/schemas/selectPsuAuthenticationMethod"
- $ref: "#/components/schemas/transactionAuthorisation"
- $ref: "#/components/schemas/authorisationConfirmation"
examples:
"Update PSU identification (Decoupled Approach)":
value: {}
"Update PSU authentication (Embedded Approach)":
$ref: "#/components/examples/updatePsuAuthenticationExample_Embedded"
"Select PSU authentication method (Embedded Approach)":
$ref: "#/components/examples/selectPsuAuthenticationMethodExample_Embedded"
"Transaction authorisation (Embedded Approach)":
$ref: "#/components/examples/transactionAuthorisationExample_Embedded"
"Authorisation confirmation (Redirect Approach)":
$ref: "#/components/examples/authorisationConfirmationExample_Redirect"
responses:
'200':
$ref: "#/components/responses/OK_200_UpdatePsuData"
'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}/cancellation-authorisations:
post:
summary: Start the authorisation process for the cancellation of the addressed payment
description: |
Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment.
The message might in addition transmit authentication and authorisation related data.
This 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 cancellation-authorisation.
The ASPSP might make the usage of this access method unnecessary in case
of only one SCA process needed, since the related authorisation resource
might be automatically created by the ASPSP after the submission of the
payment data with the first POST payments/{payment-product} 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 a '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'
* 'startAuthorisationWithAuthentciationMethodSelection'
* The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
* The ASPSP has indicated with a '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: startPaymentInitiationCancellationAuthorisation
tags:
- Payment Initiation Service (PIS)
- Common Services
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/paymentService"
- $ref: "#/components/parameters/paymentProduct"
- $ref: "#/components/parameters/paymentId"
#query # NO QUERY PARAMETER
#header
#common header parameter
- $ref: "#/components/parameters/X-Request-ID"
#header to support the signature function
- $ref: "#/components/parameters/Digest"