/
psd2.yaml
2053 lines (2053 loc) · 79.9 KB
/
psd2.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
tags:
- name: accounts
description: 'Listing of accounts'
- name: consents
description: 'Managing consents'
- name: funds
description: 'Check funds'
- name: payments
description: 'Initiate payments'
info:
version: 0.0.3
title: OpenPSD NextGen PSD2
description: PSD2 API based on the Berlin Group specification 1.1 for NextGen PSD2 (May 11 2018)
contact:
name: OpenPSD
email: webmaster@openpsd.org
url: http://openpsd.org
termsOfService: http://openpsd.org/
license:
name: Berlin Group specification is published under the Creative Commons Attribution-NoDerivatives 4.0 International Public License
url: https://creativecommons.org/licenses/by-nd/4.0/
servers:
- url: '{protocol}://api.openpsd.org/psd2/v1'
variables:
protocol:
enum:
- https
default: https
description: Sandbox
components:
schemas:
consentId:
type: string
description: 'Identification of the consent resource as it is used in the API structure. Shall be contained, if a consent resource was generated.'
example: 'qwer3456tzui7890'
frequency:
type: string
enum:
- Daily
- Weekly
- EveryTwoWeeks
- Monthly
- EveryTwoMonths
- Quarterly
- SemiAnnual
- Annual
transactionFeeIndicator:
type: boolean
scaStatus:
type: string
description: This data element is containing information about the status of the SCA method applied. This is free text but might be coded in a future version of the specification.
scaAuthenticationData:
type: string
description: SCA authentication data, depending on the chosen authentication method. If the data is binary, then it is base64 encoded.
psuMessage:
type: string
description: 'Text to be displayed to the PSU'
paymentId:
type: string
description: 'resource identification of the generated payment initiation resource.'
HrefType:
type: string
Authorization:
type: string
example: 'Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhbGxvd2VkX25vZGVzIjoiZmRhYWU1ODYtYWE1NS00MzJjLTQxODEtYjRiYzY2MDljNzQ2IiwiZXhwIjoxNTU4NTMyMTI0LCJvd25lciI6IjViMDQxYzljNDVmOTJlMGExNzdlOThjYyJ9.uif9dlFO8qEQGrLh9bThtT4H_sUeL43nfx0PL-RTgd5KL9WaO5TADLPIgBu02h2I39jRRb978ZYiv2xseAK8xpR13vz8cQUjIX0FpLnrKomfvl_nyzefVkcUH_DrNGkcPZswoVNFbfeUWER1c8I0fUudVsnxHExRJ_S-Lq1vWCSDChy89Vm_bliYdt8DppyELaBadFPqxeRRkn-szpr8sAvDgbb-OccT3LsiylkqJ5g4BWqj9qLpBO4xkzSTLjdKvgipRcNwv_dKOcwF3OI90TAaX1aEm856Zg1hBLrYnae1oceBfRYl7rjtDQo3S_R0j5pLhb7Kd-ErHec6nyaoOQ'
ConsentStatus:
type: string
enum:
- received
- rejected
- valid
- revokedByPsu
- expired
- terminatedByTpp
description: 'authentication status of the consent'
example: 'received'
Currency:
type: string
pattern: '^[A-Z]{3}$'
description: ISO 4217 Alpha 3 currency code
maxLength: 3
example: 'EUR'
ExchangeRate:
type: object
required:
- currencyFrom
- rateFrom
- currencyTo
- rateTo
- rateDate
properties:
currencyFrom:
$ref: '#/components/schemas/Currency'
rateFrom:
type: string
currencyTo:
$ref: '#/components/schemas/Currency'
rateTo:
type: string
rateDate:
type: string
format: date
example: '2017-10-30'
rateContract:
type: string
PSUData:
type: object
properties:
password:
type: string
example: 'very42secret%'
Address:
type: object
required:
- country
properties:
street:
type: string
maxLength: 70
buildingNumber:
type: string
city:
type: string
postalCode:
type: string
country:
type: string
Remittance:
type: object
required:
- reference
properties:
reference:
type: string
maxLength: 35
referenceType:
type: string
maxLength: 35
referenceIssuer:
type: string
maxLength: 35
Amount:
type: object
required:
- currency
- amount
properties:
currency:
$ref: '#/components/schemas/Currency'
amount:
type: string
description: 'The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.'
example: '123.42'
AccountReference:
type: object
description: 'This type is containing any account identification which can be used on payload-level to address specific accounts. The ASPSP will document which account reference type it will support. Exactly one of the attributes defined as "conditional" shall be used.'
properties:
iban:
type: string
pattern: '^[A-Z]{2}[0-9]{2}[A-Z0-9]{1-30}$'
description: 'This data element can be used in the body of the Consent Request Message for retrieving account access consent from this payment account.'
example: 'DE89370400440532013000'
bban:
type: string
format: bban
description: This data element can be used in the body of the Consent Request Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN.
pan:
type: string
maxLength: 35
description: 'Primary Account Number (PAN) of a card, can be tokenized by the ASPSP due to PCI DSS requirements. This data element can be used in the body of the Consent Request Message for retrieving account access consent from this card.'
maskedPan:
type: string
maxLength: 35
description: 'Primary Account Number (PAN) of a card, can be tokenized by the ASPSP due to PCI DSS requirements. This data element can be used in the body of the Consent Request Message for retrieving account access consent from this card.'
msisdn:
type: string
maxLength: 35
description: An alias to access a payment account via a registered mobile phone number. This alias might be needed e.g. in the payment initiation service. The support of this alias must be explicitly documented by the ASPSP for the corresponding API Calls.
currency:
$ref: '#/components/schemas/Currency'
AccountAccess:
type: object
properties:
accounts:
type: array
items:
$ref: '#/components/schemas/AccountReference'
description: 'Is asking for detailed account information. If the array is empty, the TPP is asking for an accessible account list. This may be restricted in a PSU/ASPSP authorization dialogue.'
balances:
type: array
items:
$ref: '#/components/schemas/AccountReference'
description: 'Is asking for balances of the addressed accounts. If the array is empty, the TPP is asking for the balances of all accessible account lists. This may be restricted in a PSU/ASPSP authorization dialogue'
transactions:
type: array
items:
$ref: '#/components/schemas/AccountReference'
description: 'Is asking for transactions of the addressed accounts. If the array is empty, the TPP is asking for the transactions of all accessible account lists. This may be restricted in a PSU/ASPSP authorization dialogue'
availableAccounts:
type: string
enum:
- allAccounts
- allAccountsWithBalances
description: 'Optional if supported by API provide. Only the values "allAccounts" or "allAccountsWithBalances" is admitted.'
allPsd2:
type: string
enum:
- allAccounts
description: 'Optional if supported by API provide. Only the value "allAccounts" is admitted.'
example: 'allAccounts'
AccountDetails:
type: object
required:
- currency
properties:
resourceid:
type: string
maxLength: 35
description: This is the data element to be used in the path when retrieving data from a dedicated account.
iban:
type: string
format: iban
description: 'This data element can be used in the body of the Consent Request Message for retrieving account access consent from this payment account.'
example: 'DE89370400440532013000'
bban:
type: string
format: bban
description: This data element can be used in the body of the Consent Request Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN.
pan:
type: string
maxLength: 35
description: 'Primary Account Number (PAN) of a card, can be tokenized by the ASPSP due to PCI DSS requirements. This data element can be used in the body of the Consent Request Message for retrieving account access consent from this card.'
maskedPan:
type: string
maxLength: 35
description: 'Primary Account Number (PAN) of a card, can be tokenized by the ASPSP due to PCI DSS requirements. This data element can be used in the body of the Consent Request Message for retrieving account access consent from this card.'
msisdn:
type: string
maxLength: 35
description: An alias to access a payment account via a registered mobile phone number. This alias might be needed e.g. in the payment initiation service. The support of this alias must be explicitly documented by the ASPSP for the corresponding API Calls.
currency:
$ref: '#/components/schemas/Currency'
name:
type: string
maxLength: 35
description: Name given by the bank or the PSU in OnlineBanking.
product:
type: string
maxLength: 35
description: Product Name of the Bank for this account, proprietary definition
cashAccountType:
type: string
description: ExternalCashAccountType1Code from ISO 20022
bic:
type: string
pattern: '([a-zA-Z]{4})([a-zA-Z]{2})(([2-9a-zA-Z]{1})([0-9a-np-zA-NP-Z]{1}))((([0-9a-wy-zA-WY-Z]{1})([0-9a-zA-Z]{2}))|([xX]{3})|)'
description: The BIC associated to the account.
format: bicfi
linkedAccounts:
type: string
maxLength: 70
description: Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.
usage:
type: string
maxLength: 140
description: 'Specifies the usage of the account - PRIV: private personal account - ORGA: professional account'
example: 'PRIV'
details:
type: string
maxLength: 140
description: 'Specifications that might be provided by the ASPSP - characteristics of the account - characteristics of the relevant card'
balances:
type: array
items:
$ref: '#/components/schemas/Balance'
_links:
$ref: '#/components/schemas/Links'
description: 'Links to the account, which can be directly used for retrieving account information from this dedicated account. Links to "balances" and/or "transactions"'
AccountReport:
type: object
required:
- booked
- _links
properties:
booked:
type: array
items:
$ref: '#/components/schemas/Transaction'
pending:
type: array
items:
$ref: '#/components/schemas/Transaction'
_links:
$ref: '#/components/schemas/Links'
description: 'The following links might be used within this context, account link (mandatory), first_page_link (optional), second_page_link (optional), current_page_ link (optional), last_page_link (optional)'
Balance:
type: object
required:
- balanceAmount
- balanceType
properties:
balanceAmount:
$ref: '#/components/schemas/Amount'
balanceType:
type: string
enum:
- closingBooked
- expected
- authorised
- openingBooked
- interimAvailable
- forwardAvailable
example: 'interimAvailable'
lastChangeDateTime:
type: string
format: date-time
referenceDate:
type: string
format: date
example: '2017-10-30'
lastCommittedTransaction:
type: string
maxLength: 35
TransactionStatus:
type: string
enum:
- ACCP
- ACSC
- ACSP
- ACTC
- ACWC
- ACWP
- RCVD
- PDNG
- RJCT
example: 'ACTC'
Transaction:
type: object
required:
- transactionAmount
properties:
transactionId:
type: string
description: 'Can be used as access-id in the API, where more details on an transaction is offered.'
entryReference:
type: string
description: 'Is the identification of the transaction as used e.g. for reference for deltafunction on application level. The same identification as for example used within camt.05x messages'
maxLength: 35
endToEndId:
type: string
description: Unique end to end identity.
maxLength: 35
mandateId:
type: string
description: Identification of a Cheque.
maxLength: 35
example: 'Mandate-2018-04-20-1234'
creditorId:
type: string
description: Identification of Creditors, e.g. a SEPA Creditor ID
maxLength: 35
bookingDate:
type: string
format: date
description: The Date when an entry is posted to an account on the ASPSPs books.
example: '2017-10-30'
valueDate:
type: string
format: date
description: The Date at which assets become available to the account owner in case of a credit
example: '2017-10-30'
transactionAmount:
$ref: '#/components/schemas/Amount'
exchangeRates:
type: array
items:
$ref: '#/components/schemas/ExchangeRate'
creditorName:
type: string
description: Identification of Creditors, e.g. a SEPA Creditor ID
maxLength: 70
creditorAccount:
$ref: '#/components/schemas/AccountReference'
ultimateCreditor:
type: string
maxLength: 70
debtorName:
type: string
description: Name of the debtor if a "Credited" transaction
maxLength: 70
debtorAccount:
$ref: '#/components/schemas/AccountReference'
ultimateDebtor:
type: string
maxLength: 70
remittanceInformationStructured:
type: string
maxLength: 140
description: Reference to be transported in the field.
puposeCode:
type: string
bankTransactionCode:
type: string
description: Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO20022
proprietaryBankTransactionCode:
type: string
maxLength: 35
description: 'proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports'
example: 'PMNT-RCVD-ESDD'
_links:
$ref: '#/components/schemas/Links'
description: 'The following links could be used here: transactionDetails for retrieving details of a transaction.'
Links:
type: object
properties:
scaRedirect:
$ref: '#/components/schemas/HrefType'
description: 'A link to an ASPSP site where SCA is performed within the Redirect SCA approach.'
scaOAuth:
$ref: '#/components/schemas/HrefType'
description: The link refers to a JSON document specifying the OAuth details of the ASPSP’s authorisation server. JSON document follows the definition given in https://tools.ietf.org/html/draft-ietf-oauth- discovery.
updatePsuIdentification:
$ref: '#/components/schemas/HrefType'
description: 'The link to the payment initiation or account information resource, which needs to be updated by the psu identification if not delivered yet.'
updateProprietaryData:
$ref: '#/components/schemas/HrefType'
description: The link to the payment initiation or account information resource, which needs to be updated by the proprietary data.
updatePsuAuthentication:
$ref: '#/components/schemas/HrefType'
description: 'The link to the payment initiation or account information resource, which needs to be updated by a psu password and eventually the psu identification if not delivered yet.'
selectAuthenticationMethod:
$ref: '#/components/schemas/HrefType'
description: 'This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods.'
authoriseTransaction:
$ref: '#/components/schemas/HrefType'
description: 'The link to the payment initiation or consent resource, where the "Transaction Authorization"Request" is sent to. This is the link to the resource which will authorize the payment or the consent by checking the SCA authentication data within the Embedded SCA approach.'
self:
$ref: '#/components/schemas/HrefType'
description: The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation.
status:
type: string
description: Status of the resource.
account:
$ref: '#/components/schemas/HrefType'
description: A link to the resource providing the details of one account
balances:
$ref: '#/components/schemas/HrefType'
description: A link to the resource providing the balance of a dedicated account.
transactions:
$ref: '#/components/schemas/HrefType'
description: A link to the resource providing the transaction history of a dediated amount.
transactionsDetails:
$ref: '#/components/schemas/HrefType'
description: A link to the resource providing details of a dedicated transaction.
first:
$ref: '#/components/schemas/HrefType'
description: Navigation link for paginated account reports.
next:
$ref: '#/components/schemas/HrefType'
description: Navigation link for paginated account reports.
previous:
$ref: '#/components/schemas/HrefType'
description: Navigation link for paginated account reports.
last:
$ref: '#/components/schemas/HrefType'
description: Navigation link for paginated account reports.
download:
$ref: '#/components/schemas/HrefType'
description: Download link for huge AIS data packages.
Authentication:
type: object
required:
- authenticationType
- authenticationMethodId
properties:
authenticationType:
type: string
enum:
- SMS_OTP
- CHIP_OTP
- PHOTO_OTP
- PUSH_OTP
authenticationVersion:
type: string
description: 'Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP’s documentation.'
authenticationMethodId:
type: string
maxLength: 35
description: 'An identification provided by the ASPSP for the later identification of the authentication method selection.'
name:
type: string
description: 'This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.'
explanation:
type: string
description: 'detailed information about the sca method for the PSU.'
Challenge:
type: object
properties:
image:
type: string
description: 'PNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method.'
data:
type: string
description: 'String challenge data'
imageLink:
type: string
description: 'A link where the ASPSP will provides the challenge image for the TPP.'
otpMaxLength:
type: integer
description: 'The maximal length for the OTP to be typed in by the PSU.'
otpFormat:
type: string
description: 'The format type of the OTP to be typed in. The admitted values are "characters" or "integer".'
enum:
- characters
- integer
additionalInformation:
type: string
description: 'Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen sca method'
MessageCode:
type: string
enum:
# ServiceUnspecificHTTPErrorCodes
- CERTIFICATE_INVALID
- CERTIFICATE_EXPIRED
- CERTIFICATE_BLOCKED
- CERTIFICATE_REVOKED
- CERTIFICATE_MISSING
- SIGNATURE_INVALID
- SIGNATURE_MISSING
- FORMAT_ERROR
- PARAMETER_NOT_SUPPORTED
- PSU_CREDENTIALS_INVALID
- SERVICE_INVALID
- SERVICE_BLOCKED
- CORPORATE_ID_INVALID
- CONSENT_UNKNOWN
- CONSENT_INVALID
- CONSENT_EXPIRED
- TOKEN_UNKNOWN
- TOKEN_INVALID
- TOKEN_EXPIRED
- RESOURCE_UNKNOWN
- RESOURCE_EXPIRED
- TIMESTAMP_INVALID
- PERIOD_INVALID
- SCA_METHOD_UNKNOWN
# PISSpecificHTTPErrorCodes
- PRODUCT_INVALID
- PRODUCT_UNKNOWN
- PAYMENT_FAILED
- REQUIRED_KID_MISSING
- EXECUTION_DATE_INVALID
# AISSpecificHTTPErrorCodes
- SESSIONS_NOT_SUPPORTED
- ACCESS_EXCEEDED
- REQUESTED_FORMATS_INVALID
# PIISSpecificErrorCodes
- CARD_INVALID
- NO_PIIS_ACTIVATION
example: TOKEN_INVALID
TppMessage:
type: object
required:
- category
- code
- text
properties:
category:
type: string
enum:
- WARNING
- ERROR
example: 'ERROR'
code:
$ref: '#/components/schemas/MessageCode'
text:
type: string
maxLength: 512
example: 'additional text information of the ASPSP up to 512 characters'
path:
type: string
recurringIndicator:
type: boolean
description: '"true" if the consent is for recurring access to the account data "false", if the consent is for one access to the account data'
CreateConsentsRequest:
type: object
required:
- access
- recurringIndicator
- validUntil
- frequencyPerDay
- combinedServiceIndicator
properties:
access:
$ref: '#/components/schemas/AccountAccess'
recurringIndicator:
$ref: '#/components/schemas/recurringIndicator'
validUntil:
type: string
format: date
description: 'This parameter is requesting a valid until date for the requested consent. The content is the local ASPSP date in ISODate Format, e.g. 2017-10-30. If a maximal available date is requested, a date in far future is to be used: "9999-12-31". The consent object to be retrieved by the GET Consent Request will contain the adjusted date.'
example: '2017-10-30'
frequencyPerDay:
type: integer
description: 'This field indicates the requested maximum frequency for an access per day. For a one-off access, this attribute is set to "1".'
example: 1
combinedServiceIndicator:
type: boolean
description: 'If "true" indicates that a payment initiation service will be addressed in the same "session", cp. Section 8.'
CreateConsentsResponse:
type: object
required:
- consentStatus
- _links
properties:
consentStatus:
$ref: '#/components/schemas/ConsentStatus'
consentId:
$ref: '#/components/schemas/consentId'
scaMethods:
type: array
items:
$ref: '#/components/schemas/Authentication'
chosenScaMethod:
$ref: '#/components/schemas/Authentication'
challengeData:
$ref: '#/components/schemas/Challenge'
_links:
$ref: '#/components/schemas/Links'
psuMessage:
$ref: '#/components/schemas/psuMessage'
SinglePaymentInitiationRequest:
type: object
BulkPaymentInitiationRequest:
type: object
PeriodicPaymentInitiationRequest:
type: object
required:
- startDate
properties:
startDate:
type: string
format: date
example: '2017-10-30'
executionRule:
type: string
enum: [following, preceeding]
endDate:
type: string
format: date
example: '2018-10-30'
frequency:
$ref: '#/components/schemas/frequency'
dayOfExecution:
type: integer
minimum: 1
maximum: 31
UpdatePSUDataAuthenticationRequest:
type: object
properties:
psuData:
$ref: '#/components/schemas/PSUData'
UpdatePSUDataAuthenticationResponse:
type: object
required:
- transactionStatus
properties:
chosenScaMethod:
$ref: '#/components/schemas/Authentication'
challengeData:
$ref: '#/components/schemas/Challenge'
scaMethods:
type: array
items:
$ref: '#/components/schemas/Authentication'
_links:
$ref: '#/components/schemas/Links'
transactionStatus:
$ref: '#/components/schemas/TransactionStatus'
consentStatus:
$ref: '#/components/schemas/ConsentStatus'
psuMessage:
$ref: '#/components/schemas/psuMessage'
UpdatePSUDataSelectAuthenticationRequest:
type: object
required:
- authenticationMethodId
properties:
authenticationMethodId:
type: string
UpdatePSUDataSelectAuthenticationResponse:
type: object
required:
- transactionStatus
properties:
chosenScaMethod:
$ref: '#/components/schemas/Authentication'
challengeData:
$ref: '#/components/schemas/Challenge'
_links:
$ref: '#/components/schemas/Links'
transactionStatus:
$ref: '#/components/schemas/TransactionStatus'
consentStatus:
$ref: '#/components/schemas/ConsentStatus'
psuMessage:
$ref: '#/components/schemas/psuMessage'
UpdatePSUDataIdentificationResponse:
type: object
required:
- transactionStatus
properties:
transactionStatus:
$ref: '#/components/schemas/TransactionStatus'
consentStatus:
$ref: '#/components/schemas/ConsentStatus'
psuMessage:
$ref: '#/components/schemas/psuMessage'
UpdatePSUDataTransactionAuthorisationRequest:
type: object
required:
- scaAuthenticationData
properties:
scaAuthenticationData:
$ref: '#/components/schemas/scaAuthenticationData'
UpdatePSUDataTransactionAuthorisationResponse:
type: object
required:
- transactionStatus
properties:
transactionStatus:
$ref: '#/components/schemas/TransactionStatus'
consentStatus:
$ref: '#/components/schemas/ConsentStatus'
# Reusable path, query, header and cookie parameters
parameters:
Content-Type:
name: Content-Type
in: header
description: 'Content-Type'
required: true
schema:
type: string
enum:
- application/json
- application/xml
- application/text
example: 'application/json'
account-id:
name: account-id
in: path
description: 'This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.'
required: true
schema:
type: string
transaction-id:
name: transaction-id
in: path
description: Transaction ID
required: true
schema:
type: integer
example: 1234570
resourceId:
name: resourceId
in: path
description: This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
required: true
schema:
type: string
maxLength: 35
example: '3dc3d5b3-7023-4848-9853-f5400a64e80f'
consentId:
name: consentId
in: path
description: ID of the corresponding consent object as returned by an Account Information Consent Request
required: true
schema:
type: string
example: 'qwer3456tzui7890'
payment-product:
name: payment-product
in: path
description: The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.
required: true
schema:
type: string
enum:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
example: 'sepa-credit-transfers'
payment-service:
name: payment-service
in: path
description: 'The payment service to use.'
required: true
schema:
type: string
enum:
- payments
- bulk-payments
- periodic-payments
example: 'payments'
paymentId:
name: paymentId
in: path
description: payment Id
required: true
schema:
type: string
example: '1234-wertiq-983'
withBalance:
name: withBalance
in: query
description: 'If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.'
required: false
schema:
type: boolean
X-Request-ID:
name: X-Request-ID
in: header
description: 'ID of the request, unique to the call, as determined by the initiating party.'
required: true
schema:
type: string
format: uuid
example: '123e4567-e89b-12d3-a456-426655440000'
Consent-ID:
name: Consent-ID
in: header
description: 'Shall be contained since "Establish Consent Transaction" was performed via this API before.'
required: true
schema:
type: string
example: 'qwer3456tzui7890'
Authorization:
name: Authorization
in: header
description: 'Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.'
required: false
schema:
type: string
example: 'Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhbGxvd2VkX25vZGVzIjoiZmRhYWU1ODYtYWE1NS00MzJjLTQxODEtYjRiYzY2MDljNzQ2IiwiZXhwIjoxNTU4NTMyMTI0LCJvd25lciI6IjViMDQxYzljNDVmOTJlMGExNzdlOThjYyJ9.uif9dlFO8qEQGrLh9bThtT4H_sUeL43nfx0PL-RTgd5KL9WaO5TADLPIgBu02h2I39jRRb978ZYiv2xseAK8xpR13vz8cQUjIX0FpLnrKomfvl_nyzefVkcUH_DrNGkcPZswoVNFbfeUWER1c8I0fUudVsnxHExRJ_S-Lq1vWCSDChy89Vm_bliYdt8DppyELaBadFPqxeRRkn-szpr8sAvDgbb-OccT3LsiylkqJ5g4BWqj9qLpBO4xkzSTLjdKvgipRcNwv_dKOcwF3OI90TAaX1aEm856Zg1hBLrYnae1oceBfRYl7rjtDQo3S_R0j5pLhb7Kd-ErHec6nyaoOQ'
Digest:
name: Digest
in: header
description: 'Is contained if and only if the "Signature" element is contained in the header of the request.'
required: false
schema:
type: string
example: 'SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A='
Signature:
name: Signature
in: header
description: 'A signature of the request by the TPP on application level. This might be mandated by ASPSP.'
required: false
schema:
type: string
example: 'keyId="SN=9FA1,CA=CN=D-TRUST%20CA%202-1%202015,O=D- Trust%20GmbH,C=DE",algorithm="rsa-sha256",headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date",signature="Base64(RSA-SHA256(signing string))"'
dateFrom:
name: dateFrom
in: query
description: 'Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required'
example: '2017-10-30'
required: false
schema:
type: string
format: date
dateTo:
name: dateTo
in: query
description: 'End date (inclusive the data dateTo) of the transaction list, default is now if not given.'
required: false
example: '2017-10-30'
schema:
type: string
format: date
entryReferenceFrom:
name: entryReferenceFrom
in: query
description: 'This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.'
required: false
schema:
type: string
bookingStatus:
name: bookingStatus
in: query
description: 'Permitted codes are "booked", "pending" and "both "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend'
required: true
schema:
type: string
example: 'booked'
PSU-ID:
name: PSU-ID
in: header
description: Might be mandated in the ASPSP's documentation, if OAuth is not chosen as Pre-Step.
required: false
schema:
type: string
example: 'PSU-1234'
PSU-ID-Type:
name: PSU-ID-Type
in: header
description: Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
required: false
schema:
type: string
PSU-Corporate-ID:
name: PSU-Corporate-ID
in: header
description: Might be mandated in the ASPSP's documentation. Only used in a corporate context.
required: false
schema:
type: string
PSU-Corporate-ID-Type:
name: PSU-Corporate-ID-Type
in: header
description: Might be mandated in the ASPSPs documentation. Only used in a corporate context.
required: false
schema:
type: string
PSU-IP-Address:
name: PSU-IP-Address
in: header
description: The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP.
required: true
schema:
type: string
example: '172.25.77.8'
PSU-IP-Port:
name: PSU-IP-Port
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
schema:
type: string
example: '9988'
PSU-Accept:
name: PSU-Accept
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
schema:
type: string
PSU-Accept-Charset:
name: PSU-Accept-Charset
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
schema:
type: string
PSU-Accept-Encoding:
name: PSU-Accept-Encoding
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
schema:
type: string
PSU-Accept-Language:
name: PSU-Accept-Language
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
schema:
type: string
PSU-User-Agent:
name: PSU-User-Agent
in: header
description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
required: false
schema:
type: string
PSU-Http-Method:
name: PSU-Http-Method
in: header
description: HTTP method used at the PSU - TPP interface, if available.
required: false
schema:
type: string
enum: [GET, POST, PUT, DELETE, PATCH]
PSU-Device-ID:
name: PSU-Device-ID
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
schema:
type: string
PSU-Geo-Location:
name: PSU-Geo-Location
in: header
description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available.
required: false
schema:
type: string
deltaList:
name: deltaList