-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
17864 lines (17864 loc) · 739 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: API para PSD2
description: API de Redsys para PSD2
version: "1.1"
servers:
- url: /api-entrada-xs2a
tags:
- name: PSD2
description: Endpoints disponibles para HUB PSD2
paths:
/api-entrada-xs2a/services/{aspsp}/v1.1/consents:
post:
tags:
- Consentimiento de información sobre cuentas de pago (AIS)
summary: Solicitud de consentimiento AIS
description: Con este servicio, un TPP a través del HUB puede solicitar un consentimiento
para acceder a las cuentas del PSU. Esta solicitud puede ser sobre unas cuentas
indicadas o no.
operationId: postConsents
parameters:
- name: aspsp
in: path
description: Nombre del ASPSP al que desea realizar la petición.
required: true
schema:
type: string
x-ibm-languages:
description:
en: Name of the ASPSP to which you wish to make the request.
x-ibm-languages:
description:
en: Name of the ASPSP to which you wish to make the request.
- name: X-Request-ID
in: header
description: 'Identificador único de la transacción asignado por el TPP. Ej:
X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7'
required: true
schema:
type: string
x-ibm-languages:
description:
en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID:
1b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
x-ibm-languages:
description:
en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID:
1b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
- name: Authorization
in: header
description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2.
Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA'
required: true
schema:
type: string
default: Bearer 6yBnsqnMQQ
x-ibm-languages:
description:
en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex:
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA '
x-ibm-languages:
description:
en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex:
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA '
- name: PSU-IP-Address
in: header
description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no
está disponible, el TPP debe usar la dirección IP usada por el TPP cuando
envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5'
required: true
schema:
type: string
x-ibm-languages:
description:
en: 'IP address of the HTPP request between the PSU and the TPP. If
not available, the TPP must use the IP address used by the TPP when
sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 '
x-ibm-languages:
description:
en: 'IP address of the HTPP request between the PSU and the TPP. If not
available, the TPP must use the IP address used by the TPP when sending
this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 '
- name: PSU-IP-Port
in: header
description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está
disponible. Ejemplo: PSU-IP-Port: 443'
schema:
type: string
x-ibm-languages:
description:
en: 'IP port of the HTTP request between the PSU and the TPP if available.
Example: PSU-IP-Port: 443 '
x-ibm-languages:
description:
en: 'IP port of the HTTP request between the PSU and the TPP if available.
Example: PSU-IP-Port: 443 '
- name: PSU-Accept
in: header
description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept:
application/json'
schema:
type: string
x-ibm-languages:
description:
en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept:
application / json '
x-ibm-languages:
description:
en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept:
application / json '
- name: PSU-Accept-Charset
in: header
description: 'Accept charset header de la petición HTTP entre PSU y el TPP.
PSU-Accept-Charset: utf-8'
schema:
type: string
x-ibm-languages:
description:
en: 'Accept charset header of the HTTP request between PSU and TPP.
PSU-Accept-Charset: utf-8 '
x-ibm-languages:
description:
en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset:
utf-8 '
- name: PSU-Accept-Encoding
in: header
description: 'Accept encoding header de la petición HTTP entre PSU y el TPP.
PSU-Accept-Language: gzip '
schema:
type: string
x-ibm-languages:
description:
en: 'Accept encoding header of the HTTP request between PSU and TPP.
PSU-Accept-Language: gzip '
x-ibm-languages:
description:
en: 'Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language:
gzip '
- name: PSU-Accept-Language
in: header
description: 'Accept language header de la petición HTTP entre PSU y el TPP.
PSU-Accept-Language: es-ES '
schema:
type: string
x-ibm-languages:
description:
en: 'Accept language header of the HTTP request between PSU and TPP.
PSU-Accept-Language: en-ES '
x-ibm-languages:
description:
en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language:
en-ES '
- name: PSU-User-Agent
in: header
description: 'Navegador o sistema operativo de la petición HTTP entre el PSU
y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1;
en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) '
schema:
type: string
x-ibm-languages:
description:
en: 'Browser or operating system of the HTTP request between the PSU
and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows
NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET
CLR 3.5.30729) '
x-ibm-languages:
description:
en: 'Browser or operating system of the HTTP request between the PSU and
the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows
NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR
3.5.30729) '
- name: PSU-Http-Method
in: header
description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos:
POST. Ej: PSU-Http-Method: POST '
schema:
type: string
default: POST
x-ibm-languages:
description:
en: 'HTTP method used in the interface between PSU and TPP. Allowed
values: POST. Ex: PSU-Http-Method: POST '
x-ibm-languages:
description:
en: 'HTTP method used in the interface between PSU and TPP. Allowed values:
POST. Ex: PSU-Http-Method: POST '
- name: PSU-Device-ID
in: header
description: 'UUID (Universally Unique Identifier) para un dispositivo. El
UUID identifica al dispositivo o a una instalación de una aplicación en
un dispositivo. Este ID no debe ser modificado hasta la desinstalación de
la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7'
schema:
type: string
x-ibm-languages:
description:
en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies
the device or an installation of an application on a device. This
ID should not be modified until the device application is uninstalled.
Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
x-ibm-languages:
description:
en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies
the device or an installation of an application on a device. This ID
should not be modified until the device application is uninstalled.
Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
- name: PSU-Geo-Location
in: header
description: 'Localización correspondiente a la petición HTTP entre el PSU
y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963'
schema:
type: string
x-ibm-languages:
description:
en: 'Location corresponding to the HTTP request between the PSU and
the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 '
x-ibm-languages:
description:
en: 'Location corresponding to the HTTP request between the PSU and the
TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 '
- name: PSU-ID
in: header
description: Identificador que el PSU utiliza para identificarse en su ASPSP.
Puede ser informado incluso si se está usando un token de OAuth y, en tal
caso, el ASPSP podría comprobar que el PSU-ID y el token se corresponden.
schema:
type: string
x-ibm-languages:
description:
en: Identifier that the PSU uses to identify itself to its ASPSP. It
can be reported even if an OAuth token is being used and, in such
a case, the ASPSP could check that the PSU-ID and token match.
x-ibm-languages:
description:
en: Identifier that the PSU uses to identify itself to its ASPSP. It can
be reported even if an OAuth token is being used and, in such a case,
the ASPSP could check that the PSU-ID and token match.
- name: PSU-ID-Type
in: header
description: Tipo del PSU-ID. Necesario en escenarios donde el PSU tiene varios
PSU-IDs como posibilidades de acceso.
schema:
type: string
x-ibm-languages:
description:
en: PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs
as access possibilities.
x-ibm-languages:
description:
en: PSU-ID type. Necessary in scenarios where the PSU has several PSU-IDs
as access possibilities.
- name: PSU-Corporate-ID
in: header
description: Identificador de "empresa" en los Canales Online.
schema:
type: string
x-ibm-languages:
description:
en: Company" identifier in the Online Channels.
x-ibm-languages:
description:
en: Company" identifier in the Online Channels.
- name: PSU-Corporate-ID-Type
in: header
description: Tipo del PSU-Corporate-ID necesario por el ASPSP para identificar
su contenido.
schema:
type: string
x-ibm-languages:
description:
en: Type of PSU-Corporate-ID required by the ASPSP to identify its contents.
x-ibm-languages:
description:
en: Type of PSU-Corporate-ID required by the ASPSP to identify its contents.
- name: TPP-Redirect-Preferred
in: header
description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por
redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no
ser redireccionado para SCA y el procedimiento será por flujo desacoplado.
Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo
del método SCA elegido por el TPP/PSU.
schema:
type: boolean
x-ibm-languages:
description:
en: 'If it is "true", the TPP has informed the HUB that it prefers SCA
by redirection. If it is "false", the TPP has informed the HUB that
it prefers not to be redirected to SCA and the procedure will be by
decoupled flow. If the parameter is not used, the ASPSP will choose
the SCA flow to be applied depending on the SCA method chosen by the
TPP / PSU. '
x-ibm-languages:
description:
en: 'If it is "true", the TPP has informed the HUB that it prefers SCA
by redirection. If it is "false", the TPP has informed the HUB that
it prefers not to be redirected to SCA and the procedure will be by
decoupled flow. If the parameter is not used, the ASPSP will choose
the SCA flow to be applied depending on the SCA method chosen by the
TPP / PSU. '
- name: TPP-Redirect-URI
in: header
description: 'URI del TPP donde el flujo de la transacción debe ser redirigido
después de alguna de las fases del SCA. Es recomendado usar siempre este
campo de cabecera.En el futuro, este campo podría cambiar a obligatorio.
Ej: TPP-Redirect-URI: https://www.tpp.com/cb'
schema:
type: string
default: www.example.com
x-ibm-languages:
description:
en: 'TPP URI where the transaction flow must be redirected after one
of the SCA phases. It is recommended to always use this header field.
In the future, this field may change to mandatory. Ex: TPP-Redirect-URI:
https://www.tpp.com/cb '
x-ibm-languages:
description:
en: 'TPP URI where the transaction flow must be redirected after one of
the SCA phases. It is recommended to always use this header field. In
the future, this field may change to mandatory. Ex: TPP-Redirect-URI:
https://www.tpp.com/cb '
- name: TPP-Nok-Redirect-URI
in: header
description: Si esta URI es contenida, el TPP está solicitando redirigir el
flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en
caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"
schema:
type: string
default: www.exampleNOK.com
x-ibm-languages:
description:
en: 'If this URI is contained, the TPP is requesting to redirect the
flow of the transaction to this address instead of the TPP-Redirect-URI
in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI":
"https://www.tpp.com/cb/nok" '
x-ibm-languages:
description:
en: 'If this URI is contained, the TPP is requesting to redirect the flow
of the transaction to this address instead of the TPP-Redirect-URI in
case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI":
"https://www.tpp.com/cb/nok" '
- name: TPP-Brand-Logging-Information
in: header
description: Este campo podría ser usado por el TPP para informar al ASPSP
acerca de la marca (Brand) usada por el TPP de cara al PSU. Esta información
puede ser usada para mejorar la comunicación entre el ASPSP y el PSU o el
ASPSP y el TPP.
schema:
type: string
x-ibm-languages:
description:
en: This field could be used by the TPP to inform the ASPSP about the
Brand used by the TPP towards the PSU. This information can be used
to improve communication between the ASPSP and the PSU or the ASPSP
and the TPP.
x-ibm-languages:
description:
en: This field could be used by the TPP to inform the ASPSP about the
Brand used by the TPP towards the PSU. This information can be used
to improve communication between the ASPSP and the PSU or the ASPSP
and the TPP.
- name: Digest
in: header
description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ=='
required: true
schema:
type: string
x-ibm-languages:
description:
en: 'It is content if the Signature field travels. Ex: Digest: SHA-256
= NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ
== '
x-ibm-languages:
description:
en: 'It is content if the Signature field travels. Ex: Digest: SHA-256
= NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ
== '
- name: Signature
in: header
description: 'Firma de la petición por el TPP. '
required: true
schema:
type: string
x-ibm-languages:
description:
en: 'Signature of the petition by the TPP. '
x-ibm-languages:
description:
en: 'Signature of the petition by the TPP. '
- name: TPP-Signature-Certificate
in: header
description: 'Certificado del TPP usado para firmar la petición, en base64,
sin cabecera, pie ni saltos de linea. Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA '
required: true
schema:
type: string
x-ibm-languages:
description:
en: 'TPP certificate used to sign the petition, in base64, without header,
footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ
………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA '
x-ibm-languages:
description:
en: 'TPP certificate used to sign the petition, in base64, without header,
footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ
………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA '
requestBody:
description: Accesos solicitados a los servicios. Solo los sub atributos con
tags “accounts”, “balances” y “transactions” son aceptados. Adicionalmente
el ASPSP puede soportar los sub atributos "availableAccounts" o "allPsd2"
con valor “all-accounts”.
content:
'*/*':
schema:
$ref: '#/components/schemas/Request_GetConsent'
required: true
responses:
default:
description: HTTP/1.1 201 Created
headers:
X-Request-ID:
description: Identificador único de la operación asignado por el TPP.
schema:
type: string
ASPSP-SCA-Approach:
description: Valor devuelto si el método SCA ha sido fijado. El SCA
basado en OAuth será tomado como REDIRECT.
schema:
type: string
enum:
- EMBEDDED
- DECOUPLED
- REDIRECT
Location:
description: Contiene el link al recurso generado.
schema:
type: string
content:
'*/*':
schema:
$ref: '#/components/schemas/Response_GetConsent'
x-ibm-languages:
summary:
en: Request for AIS consent
description:
en: 'With this service, a TPP through the HUB can request a consent to access
the PSU accounts. This request can be about indicated accounts or not. '
x-codegen-request-body-name: body
/api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}/status:
get:
tags:
- Obtener estado de consentimiento
summary: Estado de consentimiento AIS
description: Este servicio permite al TPP conocer el estado de una solicitud
de consentimiento iniciada previamente.
operationId: getConsentStatus
parameters:
- name: aspsp
in: path
description: Nombre del ASPSP al que desea realizar la petición.
required: true
schema:
type: string
x-ibm-languages:
description:
en: Name of the ASPSP to which you wish to make the request.
x-ibm-languages:
description:
en: Name of the ASPSP to which you wish to make the request.
- name: consent-id
in: path
required: true
schema:
type: string
- name: X-Request-ID
in: header
description: 'Identificador único de la transacción asignado por el TPP. Ej:
X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7'
required: true
schema:
type: string
x-ibm-languages:
description:
en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID:
1b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
x-ibm-languages:
description:
en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID:
1b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
- name: Authorization
in: header
description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2.
Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA'
required: true
schema:
type: string
default: Bearer 6yBnsqnMQQ
x-ibm-languages:
description:
en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex:
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA '
x-ibm-languages:
description:
en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex:
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA '
- name: PSU-IP-Address
in: header
description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no
está disponible, el TPP debe usar la dirección IP usada por el TPP cuando
envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5'
schema:
type: string
x-ibm-languages:
description:
en: 'IP address of the HTPP request between the PSU and the TPP. If
not available, the TPP must use the IP address used by the TPP when
sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 '
x-ibm-languages:
description:
en: 'IP address of the HTPP request between the PSU and the TPP. If not
available, the TPP must use the IP address used by the TPP when sending
this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 '
- name: PSU-IP-Port
in: header
description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está
disponible. Ejemplo: PSU-IP-Port: 443'
schema:
type: string
x-ibm-languages:
description:
en: 'IP port of the HTTP request between the PSU and the TPP if available.
Example: PSU-IP-Port: 443 '
x-ibm-languages:
description:
en: 'IP port of the HTTP request between the PSU and the TPP if available.
Example: PSU-IP-Port: 443 '
- name: PSU-Accept
in: header
description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept:
application/json'
schema:
type: string
x-ibm-languages:
description:
en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept:
application / json '
x-ibm-languages:
description:
en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept:
application / json '
- name: PSU-Accept-Charset
in: header
description: 'Accept charset header de la petición HTTP entre PSU y el TPP.
PSU-Accept-Charset: utf-8'
schema:
type: string
x-ibm-languages:
description:
en: 'Accept charset header of the HTTP request between PSU and TPP.
PSU-Accept-Charset: utf-8 '
x-ibm-languages:
description:
en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset:
utf-8 '
- name: PSU-Accept-Encoding
in: header
description: 'Accept encoding header de la petición HTTP entre PSU y el TPP.
PSU-Accept-Language: gzip '
schema:
type: string
x-ibm-languages:
description:
en: 'Accept encoding header of the HTTP request between PSU and TPP.
PSU-Accept-Language: gzip '
x-ibm-languages:
description:
en: 'Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language:
gzip '
- name: PSU-Accept-Language
in: header
description: 'Accept language header de la petición HTTP entre PSU y el TPP.
PSU-Accept-Language: es-ES '
schema:
type: string
x-ibm-languages:
description:
en: 'Accept language header of the HTTP request between PSU and TPP.
PSU-Accept-Language: en-ES '
x-ibm-languages:
description:
en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language:
en-ES '
- name: PSU-User-Agent
in: header
description: 'Navegador o sistema operativo de la petición HTTP entre el PSU
y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1;
en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) '
schema:
type: string
x-ibm-languages:
description:
en: 'Browser or operating system of the HTTP request between the PSU
and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows
NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET
CLR 3.5.30729) '
x-ibm-languages:
description:
en: 'Browser or operating system of the HTTP request between the PSU and
the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows
NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR
3.5.30729) '
- name: PSU-Http-Method
in: header
description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos:
POST. Ej: PSU-Http-Method: POST '
schema:
type: string
default: GET
x-ibm-languages:
description:
en: 'HTTP method used in the interface between PSU and TPP. Allowed
values: POST. Ex: PSU-Http-Method: POST '
x-ibm-languages:
description:
en: 'HTTP method used in the interface between PSU and TPP. Allowed values:
POST. Ex: PSU-Http-Method: POST '
- name: PSU-Device-ID
in: header
description: 'UUID (Universally Unique Identifier) para un dispositivo. El
UUID identifica al dispositivo o a una instalación de una aplicación en
un dispositivo. Este ID no debe ser modificado hasta la desinstalación de
la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7'
schema:
type: string
x-ibm-languages:
description:
en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies
the device or an installation of an application on a device. This
ID should not be modified until the device application is uninstalled.
Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
x-ibm-languages:
description:
en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies
the device or an installation of an application on a device. This ID
should not be modified until the device application is uninstalled.
Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
- name: PSU-Geo-Location
in: header
description: 'Localización correspondiente a la petición HTTP entre el PSU
y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963'
schema:
type: string
x-ibm-languages:
description:
en: 'Location corresponding to the HTTP request between the PSU and
the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 '
x-ibm-languages:
description:
en: 'Location corresponding to the HTTP request between the PSU and the
TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 '
- name: TPP-Redirect-Preferred
in: header
description: Si es "true", el TPP ha comunicado al HUB que prefiere SCA por
redirección. Si es "false", el TPP ha comunicado al HUB que prefiere no
ser redireccionado para SCA y el procedimiento será por flujo desacoplado.
Si el parámetro no es usado, el ASPSP elegirá el flujo SCA a aplicar dependiendo
del método SCA elegido por el TPP/PSU.
schema:
type: string
x-ibm-languages:
description:
en: 'If it is "true", the TPP has informed the HUB that it prefers SCA
by redirection. If it is "false", the TPP has informed the HUB that
it prefers not to be redirected to SCA and the procedure will be by
decoupled flow. If the parameter is not used, the ASPSP will choose
the SCA flow to be applied depending on the SCA method chosen by the
TPP / PSU. '
x-ibm-languages:
description:
en: 'If it is "true", the TPP has informed the HUB that it prefers SCA
by redirection. If it is "false", the TPP has informed the HUB that
it prefers not to be redirected to SCA and the procedure will be by
decoupled flow. If the parameter is not used, the ASPSP will choose
the SCA flow to be applied depending on the SCA method chosen by the
TPP / PSU. '
- name: TPP-Redirect-URI
in: header
description: 'URI del TPP donde el flujo de la transacción debe ser redirigido
después de alguna de las fases del SCA. Es recomendado usar siempre este
campo de cabecera.En el futuro, este campo podría cambiar a obligatorio.
Ej: TPP-Redirect-URI: https://www.tpp.com/cb'
schema:
type: string
default: www.example.com
x-ibm-languages:
description:
en: 'TPP URI where the transaction flow must be redirected after one
of the SCA phases. It is recommended to always use this header field.
In the future, this field may change to mandatory. Ex: TPP-Redirect-URI:
https://www.tpp.com/cb '
x-ibm-languages:
description:
en: 'TPP URI where the transaction flow must be redirected after one of
the SCA phases. It is recommended to always use this header field. In
the future, this field may change to mandatory. Ex: TPP-Redirect-URI:
https://www.tpp.com/cb '
- name: TPP-Nok-Redirect-URI
in: header
description: Si esta URI es contenida, el TPP está solicitando redirigir el
flujo de la transacción a esta dirección en vez de al TPP-Redirect-URI en
caso de un resultado negativo del método de SCA por redirección. "TPP-Nok-Redirect-URI":"https://www.tpp.com/cb/nok"
schema:
type: string
default: www.exampleNOK.com
x-ibm-languages:
description:
en: 'If this URI is contained, the TPP is requesting to redirect the
flow of the transaction to this address instead of the TPP-Redirect-URI
in case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI":
"https://www.tpp.com/cb/nok" '
x-ibm-languages:
description:
en: 'If this URI is contained, the TPP is requesting to redirect the flow
of the transaction to this address instead of the TPP-Redirect-URI in
case of a negative result of the SCA method by redirection. "TPP-Nok-Redirect-URI":
"https://www.tpp.com/cb/nok" '
- name: Digest
in: header
description: 'Es contenido si viaja el campo Signature. Ej: Digest: SHA-256=NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ=='
required: true
schema:
type: string
x-ibm-languages:
description:
en: 'It is content if the Signature field travels. Ex: Digest: SHA-256
= NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ
== '
x-ibm-languages:
description:
en: 'It is content if the Signature field travels. Ex: Digest: SHA-256
= NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ
== '
- name: Signature
in: header
description: 'Firma de la petición por el TPP. '
required: true
schema:
type: string
x-ibm-languages:
description:
en: 'Signature of the petition by the TPP. '
x-ibm-languages:
description:
en: 'Signature of the petition by the TPP. '
- name: TPP-Signature-Certificate
in: header
description: 'Certificado del TPP usado para firmar la petición, en base64,
sin cabecera, pie ni saltos de linea, sin cabeceras ni saltos de linea.
Ej: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ………….KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA '
required: true
schema:
type: string
default: TestTPPCertificate
x-ibm-languages:
description:
en: 'TPP certificate used to sign the petition, in base64, without header,
footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ
………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA '
x-ibm-languages:
description:
en: 'TPP certificate used to sign the petition, in base64, without header,
footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ
………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA '
responses:
default:
description: HTTP/1.1 200 Ok
headers:
X-Request-ID:
description: Identificador único de la petición asignado por el TPP.
schema:
type: string
content:
'*/*':
schema:
$ref: '#/components/schemas/Response_StatusConsent'
x-ibm-languages:
summary:
en: AIS Consent Status
description:
en: This service allows the TPP to know the status of a previously initiated
consent request.
/api-entrada-xs2a/services/{aspsp}/v1.1/consents/{consent-id}:
get:
tags:
- Recuperar información de consentimiento
summary: Recuperar información de consentimiento AIS
description: Este servicio permite al TPP conocer el estado de una solicitud
de consentimiento iniciada previamente.
operationId: getConsentIdDetails
parameters:
- name: consent-id
in: path
required: true
schema:
type: string
- name: aspsp
in: path
description: Nombre del ASPSP al que desea realizar la petición.
required: true
schema:
type: string
x-ibm-languages:
description:
en: Name of the ASPSP to which you wish to make the request.
x-ibm-languages:
description:
en: Name of the ASPSP to which you wish to make the request.
- name: X-Request-ID
in: header
description: 'Identificador único de la transacción asignado por el TPP. Ej:
X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7'
required: true
schema:
type: string
x-ibm-languages:
description:
en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID:
1b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
x-ibm-languages:
description:
en: 'Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID:
1b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
- name: Authorization
in: header
description: 'Bearer Token. Obtenido en una autenticación previa sobre Auth2.
Ej: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA'
required: true
schema:
type: string
default: Bearer 6yBnsqnMQQ
x-ibm-languages:
description:
en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex:
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA '
x-ibm-languages:
description:
en: 'Bearer Token. Obtained in a previous authentication on Auth2. Ex:
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA '
- name: PSU-IP-Address
in: header
description: 'Dirección IP de la petición HTPP entre el PSU y el TPP. Si no
está disponible, el TPP debe usar la dirección IP usada por el TPP cuando
envía esta petición. Ej: Ej: PSU-IP-Address: 192.168.16.5'
schema:
type: string
x-ibm-languages:
description:
en: 'IP address of the HTPP request between the PSU and the TPP. If
not available, the TPP must use the IP address used by the TPP when
sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 '
x-ibm-languages:
description:
en: 'IP address of the HTPP request between the PSU and the TPP. If not
available, the TPP must use the IP address used by the TPP when sending
this request. Ex: Ex: PSU-IP-Address: 192.168.16.5 '
- name: PSU-IP-Port
in: header
description: 'Puerto IP de la petición HTTP entre el PSU y el TPP si está
disponible. Ejemplo: PSU-IP-Port: 443'
schema:
type: string
x-ibm-languages:
description:
en: 'IP port of the HTTP request between the PSU and the TPP if available.
Example: PSU-IP-Port: 443 '
x-ibm-languages:
description:
en: 'IP port of the HTTP request between the PSU and the TPP if available.
Example: PSU-IP-Port: 443 '
- name: PSU-Accept
in: header
description: 'Accept header de la petición HTTP entre PSU y el TPP. Ej: PSU-Accept:
application/json'
schema:
type: string
x-ibm-languages:
description:
en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept:
application / json '
x-ibm-languages:
description:
en: 'Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept:
application / json '
- name: PSU-Accept-Charset
in: header
description: 'Accept charset header de la petición HTTP entre PSU y el TPP.
PSU-Accept-Charset: utf-8'
schema:
type: string
x-ibm-languages:
description:
en: 'Accept charset header of the HTTP request between PSU and TPP.
PSU-Accept-Charset: utf-8 '
x-ibm-languages:
description:
en: 'Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset:
utf-8 '
- name: PSU-Accept-Encoding
in: header
description: 'Accept encoding header de la petición HTTP entre PSU y el TPP.
PSU-Accept-Language: gzip '
schema:
type: string
x-ibm-languages:
description:
en: 'Accept encoding header of the HTTP request between PSU and TPP.
PSU-Accept-Language: gzip '
x-ibm-languages:
description:
en: 'Accept encoding header of the HTTP request between PSU and TPP. PSU-Accept-Language:
gzip '
- name: PSU-Accept-Language
in: header
description: 'Accept language header de la petición HTTP entre PSU y el TPP.
PSU-Accept-Language: es-ES '
schema:
type: string
x-ibm-languages:
description:
en: 'Accept language header of the HTTP request between PSU and TPP.
PSU-Accept-Language: en-ES '
x-ibm-languages:
description:
en: 'Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language:
en-ES '
- name: PSU-User-Agent
in: header
description: 'Navegador o sistema operativo de la petición HTTP entre el PSU
y el TPP. Ejemplo: PSU-User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1;
en-US; rv:1.9.1.5) Gecko/20091102 Firefox/3.5.5 (.NET CLR 3.5.30729) '
schema:
type: string
x-ibm-languages:
description:
en: 'Browser or operating system of the HTTP request between the PSU
and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows
NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET
CLR 3.5.30729) '
x-ibm-languages:
description:
en: 'Browser or operating system of the HTTP request between the PSU and
the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows
NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR
3.5.30729) '
- name: PSU-Http-Method
in: header
description: 'Método HTTP usado en la interfaz entre PSU y TPP. Valores permitidos:
POST. Ej: PSU-Http-Method: POST '
schema:
type: string
default: GET
x-ibm-languages:
description:
en: 'HTTP method used in the interface between PSU and TPP. Allowed
values: POST. Ex: PSU-Http-Method: POST '
x-ibm-languages:
description:
en: 'HTTP method used in the interface between PSU and TPP. Allowed values:
POST. Ex: PSU-Http-Method: POST '
- name: PSU-Device-ID
in: header
description: 'UUID (Universally Unique Identifier) para un dispositivo. El
UUID identifica al dispositivo o a una instalación de una aplicación en
un dispositivo. Este ID no debe ser modificado hasta la desinstalación de
la aplicación del dispositivo. Ej: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7'
schema:
type: string
x-ibm-languages:
description:
en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies
the device or an installation of an application on a device. This
ID should not be modified until the device application is uninstalled.
Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
x-ibm-languages:
description:
en: 'UUID (Universally Unique Identifier) for a device. The UUID identifies
the device or an installation of an application on a device. This ID
should not be modified until the device application is uninstalled.
Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7 '
- name: PSU-Geo-Location
in: header
description: 'Localización correspondiente a la petición HTTP entre el PSU
y el TPP. Ej: PSU-Geo-Location: GEO:90.023856;25.345963'
schema:
type: string
x-ibm-languages:
description:
en: 'Location corresponding to the HTTP request between the PSU and
the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963 '
x-ibm-languages:
description: