forked from OpenBankingUK/read-write-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathaggregated-polling-openapi.json
524 lines (524 loc) · 16.2 KB
/
aggregated-polling-openapi.json
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
{
"openapi": "3.0.1",
"info": {
"title": "Aggregated Event Polling API Specification",
"description": "OpenAPI for Aggregated Event Polling API Specification",
"termsOfService": "https://www.openbanking.org.uk/terms",
"contact": {
"name": "Service Desk",
"email": "[email protected]"
},
"license": {
"name": "open-licence",
"url": "https://www.openbanking.org.uk/open-licence"
},
"version": "v3.1.5"
},
"paths": {
"/events": {
"post": {
"tags": [
"Events"
],
"summary": "Create Events",
"operationId": "CreateEvents",
"parameters": [
{
"$ref": "#/components/parameters/x-fapi-auth-date"
},
{
"$ref": "#/components/parameters/x-fapi-customer-ip-address"
},
{
"$ref": "#/components/parameters/x-fapi-interaction-id"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/x-customer-user-agent"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200EventsRead"
},
"201": {
"$ref": "#/components/responses/201EventsCreated"
},
"400": {
"$ref": "#/components/responses/400Error"
},
"401": {
"$ref": "#/components/responses/401Error"
},
"403": {
"$ref": "#/components/responses/403Error"
},
"404": {
"$ref": "#/components/responses/404Error"
},
"405": {
"$ref": "#/components/responses/405Error"
},
"406": {
"$ref": "#/components/responses/406Error"
},
"415": {
"$ref": "#/components/responses/415Error"
},
"429": {
"$ref": "#/components/responses/429Error"
},
"500": {
"$ref": "#/components/responses/500Error"
}
},
"security": [
{
"TPPOAuth2Security": [
"accounts",
"fundsconfirmations"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/OBEventPolling1Param"
}
}
}
},
"components": {
"parameters": {
"Authorization": {
"in": "header",
"name": "Authorization",
"required": true,
"description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750",
"schema": {
"type": "string"
}
},
"x-customer-user-agent": {
"in": "header",
"name": "x-customer-user-agent",
"description": "Indicates the user-agent that the PSU is using.",
"required": false,
"schema": {
"type": "string"
}
},
"x-fapi-customer-ip-address": {
"in": "header",
"name": "x-fapi-customer-ip-address",
"required": false,
"description": "The PSU's IP address if the PSU is currently logged in with the TPP.",
"schema": {
"type": "string"
}
},
"x-fapi-auth-date": {
"in": "header",
"name": "x-fapi-auth-date",
"required": false,
"description": "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC",
"schema": {
"type": "string",
"pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$"
}
},
"x-fapi-interaction-id": {
"in": "header",
"name": "x-fapi-interaction-id",
"required": false,
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
},
"x-idempotency-key": {
"name": "x-idempotency-key",
"in": "header",
"description": "Every request will be processed only once per x-idempotency-key. The\nIdempotency Key will be valid for 24 hours.\n",
"required": true,
"schema": {
"type": "string",
"pattern": "^(?!\\s)(.*)(\\S)$",
"maxLength": 40
}
},
"x-jws-signature": {
"in": "header",
"name": "x-jws-signature",
"required": true,
"description": "A detached JWS signature of the body of the payload.",
"schema": {
"type": "string"
}
}
},
"requestBodies": {
"OBEventPolling1Param": {
"description": "Default",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OBEventPolling1"
}
}
},
"required": true
}
},
"responses": {
"201EventsCreated": {
"description": "Events Created",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OBEventPollingResponse1"
}
}
}
},
"200EventsRead": {
"description": "Read awaiting events",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OBEventPollingResponse1"
}
}
}
},
"400Error": {
"description": "Bad request",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OBErrorResponse1"
}
}
}
},
"401Error": {
"description": "Unauthorized",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
}
},
"403Error": {
"description": "Forbidden",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OBErrorResponse1"
}
}
}
},
"404Error": {
"description": "Not found",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
}
},
"405Error": {
"description": "Method Not Allowed",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
}
},
"406Error": {
"description": "Not Acceptable",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
}
},
"415Error": {
"description": "Unsupported Media Type",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
}
},
"429Error": {
"description": "Too Many Requests",
"headers": {
"Retry-After": {
"description": "Number in seconds to wait",
"schema": {
"type": "integer"
}
},
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
}
},
"500Error": {
"description": "Internal Server Error",
"headers": {
"x-fapi-interaction-id": {
"description": "An RFC4122 UID used as a correlation id.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OBErrorResponse1"
}
}
}
}
},
"schemas": {
"OBError1": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.Field.Expected",
"UK.OBIE.Field.Invalid",
"UK.OBIE.Field.InvalidDate",
"UK.OBIE.Field.Missing",
"UK.OBIE.Field.Unexpected",
"UK.OBIE.Header.Invalid",
"UK.OBIE.Header.Missing",
"UK.OBIE.Reauthenticate",
"UK.OBIE.Resource.ConsentMismatch",
"UK.OBIE.Resource.InvalidConsentStatus",
"UK.OBIE.Resource.InvalidFormat",
"UK.OBIE.Resource.NotFound",
"UK.OBIE.Rules.AfterCutOffDateTime",
"UK.OBIE.Rules.DuplicateReference",
"UK.OBIE.Signature.Invalid",
"UK.OBIE.Signature.InvalidClaim",
"UK.OBIE.Signature.Malformed",
"UK.OBIE.Signature.Missing",
"UK.OBIE.Signature.MissingClaim",
"UK.OBIE.Signature.Unexpected",
"UK.OBIE.UnexpectedError",
"UK.OBIE.Unsupported.AccountIdentifier",
"UK.OBIE.Unsupported.AccountSecondaryIdentifier",
"UK.OBIE.Unsupported.Currency",
"UK.OBIE.Unsupported.Frequency",
"UK.OBIE.Unsupported.LocalInstrument",
"UK.OBIE.Unsupported.Scheme"
]
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
},
"OBErrorResponse1": {
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Errors": {
"items": {
"$ref": "#/components/schemas/OBError1"
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
},
"OBEventPolling1": {
"type": "object",
"properties": {
"maxEvents": {
"description": "Maximum number of events to be returned. A value of zero indicates the ASPSP should not return events even if available",
"type": "integer"
},
"returnImmediately": {
"description": "Indicates whether an ASPSP should return a response immediately or provide a long poll",
"type": "boolean"
},
"ack": {
"type": "array",
"items": {
"description": "An array of jti values indicating event notifications positively acknowledged by the TPP",
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"setErrs": {
"type": "object",
"description": "An object that encapsulates all negative acknowledgements transmitted by the TPP",
"properties": {},
"additionalProperties": {
"type": "object",
"required": [
"err",
"description"
],
"properties": {
"err": {
"description": "A value from the IANA \"Security Event Token Delivery Error Codes\" registry that identifies the error as defined here \nhttps://tools.ietf.org/id/draft-ietf-secevent-http-push-03.html#error_codes",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"description": {
"description": "A human-readable string that provides additional diagnostic information",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
}
},
"additionalProperties": false
},
"OBEventPollingResponse1": {
"type": "object",
"required": [
"moreAvailable",
"sets"
],
"properties": {
"moreAvailable": {
"description": "A JSON boolean value that indicates if more unacknowledged event notifications are available to be returned.",
"type": "boolean"
},
"sets": {
"type": "object",
"description": "A JSON object that contains zero or more nested JSON attributes. If there are no outstanding event notifications to be transmitted, the JSON object SHALL be empty.",
"properties": {},
"additionalProperties": {
"description": "An object named with the jti of the event notification to be delivered. The value is the event notification, expressed as a string.\nThe payload of the event should be defined in the OBEventNotification2 format.",
"type": "string"
}
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"TPPOAuth2Security": {
"type": "oauth2",
"description": "TPP client credential authorisation flow with the ASPSP",
"flows": {
"clientCredentials": {
"tokenUrl": "https://authserver.example/token",
"scopes": {
"accounts": "Ability to receive events associated with Accounts information",
"fundsconfirmations": "Ability to receive events associated with confirmation of funds"
}
}
}
}
}
}
}