account-lookup-service 15.5.0-iso.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (209) hide show
  1. package/.circleci/config.yml +11 -0
  2. package/.ncurc.yaml +6 -0
  3. package/.nvmrc +1 -0
  4. package/.nycrc.yml +20 -0
  5. package/.versionrc +15 -0
  6. package/CHANGELOG.md +330 -0
  7. package/CODEOWNERS +38 -0
  8. package/Dockerfile +45 -0
  9. package/LICENSE.md +10 -0
  10. package/README.md +252 -0
  11. package/audit-ci.jsonc +32 -0
  12. package/audit-resolve.json +161 -0
  13. package/config/default.json +109 -0
  14. package/config/knexfile.js +21 -0
  15. package/docker/account-lookup-service/default.json +106 -0
  16. package/docker/account-lookup-service/make-default-json.sh +5 -0
  17. package/docker/account-lookup-service/override.json +15 -0
  18. package/docker/central-ledger/default.json +458 -0
  19. package/docker/config-modifier/account-lookup-service.js +31 -0
  20. package/docker/kafka/consumer.properties +26 -0
  21. package/docker/kafka/producer.properties +45 -0
  22. package/docker/kafka/server.properties +143 -0
  23. package/docker/kafka/tools-log4j.properties +21 -0
  24. package/docker/mock-proxy/Dockerfile +15 -0
  25. package/docker/mock-proxy/package-lock.json +4986 -0
  26. package/docker/mock-proxy/package.json +24 -0
  27. package/docker/mock-proxy/src/config.ts +14 -0
  28. package/docker/mock-proxy/src/server.ts +94 -0
  29. package/docker/mock-proxy/src/utils.ts +29 -0
  30. package/docker/mock-proxy/tsconfig.json +24 -0
  31. package/docker/sql-init/01_permissions.sql +2 -0
  32. package/docker/sql-init-central-ledger/01_permissions.sql +2 -0
  33. package/docker/wait-for/wait-for-account-lookup-service.sh +10 -0
  34. package/docker/wait-for/wait-for-central-ledger.sh +11 -0
  35. package/docker/wait-for/wait-for-kafka.sh +7 -0
  36. package/docker/wait-for/wait-for-ml-api-adapter.sh +9 -0
  37. package/docker/wait-for/wait-for-mockserver.sh +20 -0
  38. package/docker/wait-for/wait-for-mysql-als.sh +14 -0
  39. package/docker/wait-for/wait-for-mysql-central-ledger.sh +11 -0
  40. package/docker/wait-for/wait-for-mysql.sh +11 -0
  41. package/docker/wait-for/wait-for-objstore.sh +12 -0
  42. package/docker/wait-for/wait-for.env +18 -0
  43. package/docker/wait-for/wait-for.sh +81 -0
  44. package/docker-compose.integration.yml +29 -0
  45. package/docker-compose.yml +243 -0
  46. package/jest-int.config.js +8 -0
  47. package/jest.config.js +16 -0
  48. package/jsdoc.json +38 -0
  49. package/migrations/01_currency.js +42 -0
  50. package/migrations/02_endpointType.js +43 -0
  51. package/migrations/03_endpointType-indexes.js +37 -0
  52. package/migrations/04_partyIdType.js +43 -0
  53. package/migrations/05_partyIdType-indexes.js +38 -0
  54. package/migrations/08_oracleEndpoint.js +51 -0
  55. package/migrations/09_oracleEndpoint-indexes.js +41 -0
  56. package/migrations/10_oracleEndpoint-remove-constraints.js +38 -0
  57. package/package.json +180 -0
  58. package/scripts/_wait4_all.js +143 -0
  59. package/scripts/test-functional.sh +76 -0
  60. package/secrets/jwsSigningKey.key +27 -0
  61. package/seeds/currency.js +765 -0
  62. package/seeds/endpointType.js +65 -0
  63. package/seeds/partyIdType.js +79 -0
  64. package/src/api/endpointcache.js +67 -0
  65. package/src/api/health.js +66 -0
  66. package/src/api/index.js +85 -0
  67. package/src/api/oracles/{ID}.js +100 -0
  68. package/src/api/oracles.js +96 -0
  69. package/src/api/participants/{ID}/error.js +44 -0
  70. package/src/api/participants/{ID}.js +44 -0
  71. package/src/api/participants/{Type}/{ID}/error.js +74 -0
  72. package/src/api/participants/{Type}/{ID}/{SubId}/error.js +68 -0
  73. package/src/api/participants/{Type}/{ID}/{SubId}.js +113 -0
  74. package/src/api/participants/{Type}/{ID}.js +133 -0
  75. package/src/api/participants.js +63 -0
  76. package/src/api/parties/{Type}/{ID}/error.js +66 -0
  77. package/src/api/parties/{Type}/{ID}/{SubId}/error.js +56 -0
  78. package/src/api/parties/{Type}/{ID}/{SubId}.js +77 -0
  79. package/src/api/parties/{Type}/{ID}.js +98 -0
  80. package/src/api/routes.js +294 -0
  81. package/src/constants.js +16 -0
  82. package/src/domain/oracle/index.js +33 -0
  83. package/src/domain/oracle/oracle.js +234 -0
  84. package/src/domain/participants/index.js +35 -0
  85. package/src/domain/participants/participants.js +560 -0
  86. package/src/domain/parties/getPartiesByTypeAndID.js +239 -0
  87. package/src/domain/parties/index.js +32 -0
  88. package/src/domain/parties/parties.js +215 -0
  89. package/src/domain/parties/utils.js +84 -0
  90. package/src/domain/timeout/dto.js +48 -0
  91. package/src/domain/timeout/index.js +104 -0
  92. package/src/handlers/TimeoutHandler.js +94 -0
  93. package/src/handlers/index.js +70 -0
  94. package/src/handlers/monitoring/index.js +51 -0
  95. package/src/handlers/monitoring/plugins/health.js +61 -0
  96. package/src/handlers/monitoring/plugins/metrics.js +48 -0
  97. package/src/handlers/register.js +102 -0
  98. package/src/index.js +66 -0
  99. package/src/interface/admin-swagger.yaml +804 -0
  100. package/src/interface/admin_swagger.json +959 -0
  101. package/src/interface/api-swagger-iso20022-parties.yaml +1734 -0
  102. package/src/interface/api-swagger.yaml +1733 -0
  103. package/src/interface/api_swagger.json +3046 -0
  104. package/src/interface/fspiop-rest-v2.0-ISO20022_parties.yaml +2256 -0
  105. package/src/interface/thirdparty/admin-swagger.yaml +808 -0
  106. package/src/interface/thirdparty/admin_swagger.json +961 -0
  107. package/src/interface/thirdparty/api-swagger.yaml +1739 -0
  108. package/src/interface/thirdparty/api_swagger.json +3142 -0
  109. package/src/lib/argv.js +39 -0
  110. package/src/lib/cache.js +126 -0
  111. package/src/lib/config.js +183 -0
  112. package/src/lib/db.js +26 -0
  113. package/src/lib/headers.js +53 -0
  114. package/src/lib/healthCheck/subServiceHealth.js +84 -0
  115. package/src/lib/index.js +11 -0
  116. package/src/lib/migrator.js +17 -0
  117. package/src/lib/requestLogger.js +54 -0
  118. package/src/lib/util.js +66 -0
  119. package/src/metrics/handler.js +33 -0
  120. package/src/metrics/plugin.js +52 -0
  121. package/src/metrics/routes.js +43 -0
  122. package/src/models/currency/currency.js +48 -0
  123. package/src/models/currency/index.js +32 -0
  124. package/src/models/endpointType/endpointType.js +48 -0
  125. package/src/models/endpointType/index.js +32 -0
  126. package/src/models/misc/migrationLock.js +49 -0
  127. package/src/models/oracle/facade.js +341 -0
  128. package/src/models/oracle/index.js +41 -0
  129. package/src/models/oracle/oracleEndpoint.js +192 -0
  130. package/src/models/oracle/oracleEndpointCached.js +108 -0
  131. package/src/models/participantEndpoint/facade.js +238 -0
  132. package/src/models/partyIdType/index.js +32 -0
  133. package/src/models/partyIdType/partyIdType.js +41 -0
  134. package/src/plugins.js +139 -0
  135. package/src/server.js +199 -0
  136. package/test/fixtures/index.js +131 -0
  137. package/test/fixtures/iso.js +110 -0
  138. package/test/integration/.env +8 -0
  139. package/test/integration/api/parties.test.js +137 -0
  140. package/test/integration/constants.js +20 -0
  141. package/test/integration/domain/oracle/index.test.js +324 -0
  142. package/test/integration/domain/timeout/index.test.js +75 -0
  143. package/test/integration/env.sh +15 -0
  144. package/test/integration/example.test.js +12 -0
  145. package/test/integration/models/currency/currency.test.js +68 -0
  146. package/test/integration/plugins.test.js +62 -0
  147. package/test/integration/prepareTestParticipants.js +30 -0
  148. package/test/integration/setup.js +5 -0
  149. package/test/integration-config.json +81 -0
  150. package/test/integration-runner.sh +108 -0
  151. package/test/unit/api/health.test.js +142 -0
  152. package/test/unit/api/oracles/{ID}.test.js +264 -0
  153. package/test/unit/api/oracles.test.js +173 -0
  154. package/test/unit/api/participants/participants.test.js +117 -0
  155. package/test/unit/api/participants/{Type}/{ID}/error.test.js +155 -0
  156. package/test/unit/api/participants/{Type}/{ID}/{SubId}/error.test.js +131 -0
  157. package/test/unit/api/participants/{Type}/{ID}/{SubId}.test.js +377 -0
  158. package/test/unit/api/participants/{Type}/{ID}.test.js +383 -0
  159. package/test/unit/api/participants.test.js +108 -0
  160. package/test/unit/api/parties/endpointcache.test.js +83 -0
  161. package/test/unit/api/parties/parties.test.js +102 -0
  162. package/test/unit/api/parties/{Type}/{ID}/error.test.js +145 -0
  163. package/test/unit/api/parties/{Type}/{ID}/{SubId}/error.test.js +141 -0
  164. package/test/unit/api/parties/{Type}/{ID}/{SubId}.test.js +241 -0
  165. package/test/unit/api/parties/{Type}/{ID}.test.js +240 -0
  166. package/test/unit/domain/oracle/oracle.test.js +505 -0
  167. package/test/unit/domain/participants/participants.test.js +1724 -0
  168. package/test/unit/domain/parties/parties.test.js +940 -0
  169. package/test/unit/domain/timeout/dto.test.js +28 -0
  170. package/test/unit/domain/timeout/index.test.js +81 -0
  171. package/test/unit/handlers/TimeoutHandler.test.js +125 -0
  172. package/test/unit/handlers/index.test.js +56 -0
  173. package/test/unit/handlers/register.test.js +90 -0
  174. package/test/unit/index.test.js +139 -0
  175. package/test/unit/iso20022/partiesValidation.test.js +129 -0
  176. package/test/unit/lib/TransformFacades.test.js +18 -0
  177. package/test/unit/lib/argv.test.js +40 -0
  178. package/test/unit/lib/cache.test.js +172 -0
  179. package/test/unit/lib/config.test.js +108 -0
  180. package/test/unit/lib/healthCheck/subServiceHealth.test.js +89 -0
  181. package/test/unit/lib/migrator.test.js +52 -0
  182. package/test/unit/lib/requestLogger.test.js +115 -0
  183. package/test/unit/lib/util.test.js +68 -0
  184. package/test/unit/mocks.js +66 -0
  185. package/test/unit/models/currency/currency.test.js +91 -0
  186. package/test/unit/models/endpointType/endpointType.test.js +69 -0
  187. package/test/unit/models/misc/migrationLock.test.js +96 -0
  188. package/test/unit/models/oracle/facade.test.js +546 -0
  189. package/test/unit/models/oracle/oracleEndpoint.test.js +409 -0
  190. package/test/unit/models/oracle/oracleEndpointCached.test.js +153 -0
  191. package/test/unit/models/participantEndpoint/facade.test.js +295 -0
  192. package/test/unit/models/partyIdType/partyIdType.test.js +88 -0
  193. package/test/unit/plugins.test.js +89 -0
  194. package/test/unit/setup.js +7 -0
  195. package/test/util/apiClients/AlsApiClient.js +44 -0
  196. package/test/util/apiClients/BasicApiClient.js +34 -0
  197. package/test/util/apiClients/ProxyApiClient.js +25 -0
  198. package/test/util/apiClients/index.js +7 -0
  199. package/test/util/helper.js +332 -0
  200. package/test/util/index.js +11 -0
  201. package/test/util/mockgen.js +43 -0
  202. package/test/util/onboarding.js +132 -0
  203. package/test/util/scripts/addAlsDb.sh +33 -0
  204. package/test/util/scripts/configureMockServer.sh +35 -0
  205. package/test/util/scripts/env.sh +19 -0
  206. package/test/util/scripts/populateTestData.sh +62 -0
  207. package/test/util/scripts/startMockCentralServer.sh +45 -0
  208. package/test/util/scripts/startMockOracleServer.sh +45 -0
  209. package/test/util/testConfig.js +44 -0
@@ -0,0 +1,1739 @@
1
+ openapi: 3.0.1
2
+ info:
3
+ title: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version) Extended
4
+ description: Based on API Definition.docx Version 1.1 that was confirmed on 2020-05-19.
5
+ Note - The API supports a maximum size of 65536 bytes (64 Kilobytes) in the HTTP
6
+ header.
7
+ license:
8
+ name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
9
+ version: "1.1"
10
+ servers:
11
+ - url: /
12
+ paths:
13
+ /participants/{ID}/error:
14
+ put:
15
+ tags:
16
+ - participants
17
+ - sampled
18
+ summary: ParticipantsByIDAndError
19
+ description: If there is an error during FSP information creation in the server,
20
+ the error callback PUT /participants/<ID>/error is used. The <ID> in the URI
21
+ should contain the requestId that was used for the creation of the participant
22
+ information.
23
+ operationId: ParticipantsErrorByIDPut
24
+ parameters:
25
+ - $ref: '#/components/parameters/ID'
26
+ - $ref: '#/components/parameters/Content-Length'
27
+ - $ref: '#/components/parameters/Content-Type'
28
+ - $ref: '#/components/parameters/Date'
29
+ - $ref: '#/components/parameters/X-Forwarded-For'
30
+ - $ref: '#/components/parameters/FSPIOP-Source'
31
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
32
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
33
+ - $ref: '#/components/parameters/FSPIOP-Signature'
34
+ - $ref: '#/components/parameters/FSPIOP-URI'
35
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
36
+ requestBody:
37
+ content:
38
+ application/json:
39
+ schema:
40
+ $ref: '#/components/schemas/ErrorInformationObject'
41
+ required: true
42
+ responses:
43
+ 200:
44
+ $ref: '#/components/responses/Response200'
45
+ 400:
46
+ $ref: '#/components/responses/ErrorResponse400'
47
+ 401:
48
+ $ref: '#/components/responses/ErrorResponse401'
49
+ 403:
50
+ $ref: '#/components/responses/ErrorResponse403'
51
+ 404:
52
+ $ref: '#/components/responses/ErrorResponse404'
53
+ 405:
54
+ $ref: '#/components/responses/ErrorResponse405'
55
+ 406:
56
+ $ref: '#/components/responses/ErrorResponse406'
57
+ 501:
58
+ $ref: '#/components/responses/ErrorResponse501'
59
+ 503:
60
+ $ref: '#/components/responses/ErrorResponse503'
61
+ /participants/{ID}:
62
+ put:
63
+ tags:
64
+ - participants
65
+ - sampled
66
+ summary: ParticipantsByID
67
+ description: The callback PUT /participants/<ID> is used to inform the client
68
+ of the result of the creation of the provided list of identities.
69
+ operationId: ParticipantsByIDPut
70
+ parameters:
71
+ - $ref: '#/components/parameters/ID'
72
+ - $ref: '#/components/parameters/Content-Length'
73
+ - $ref: '#/components/parameters/Content-Type'
74
+ - $ref: '#/components/parameters/Date'
75
+ - $ref: '#/components/parameters/X-Forwarded-For'
76
+ - $ref: '#/components/parameters/FSPIOP-Source'
77
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
78
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
79
+ - $ref: '#/components/parameters/FSPIOP-Signature'
80
+ - $ref: '#/components/parameters/FSPIOP-URI'
81
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
82
+ requestBody:
83
+ content:
84
+ application/json:
85
+ schema:
86
+ $ref: '#/components/schemas/ParticipantsIDPutResponse'
87
+ required: true
88
+ responses:
89
+ 200:
90
+ $ref: '#/components/responses/Response200'
91
+ 400:
92
+ $ref: '#/components/responses/ErrorResponse400'
93
+ 401:
94
+ $ref: '#/components/responses/ErrorResponse401'
95
+ 403:
96
+ $ref: '#/components/responses/ErrorResponse403'
97
+ 404:
98
+ $ref: '#/components/responses/ErrorResponse404'
99
+ 405:
100
+ $ref: '#/components/responses/ErrorResponse405'
101
+ 406:
102
+ $ref: '#/components/responses/ErrorResponse406'
103
+ 501:
104
+ $ref: '#/components/responses/ErrorResponse501'
105
+ 503:
106
+ $ref: '#/components/responses/ErrorResponse503'
107
+ /participants/{Type}/{ID}/error:
108
+ put:
109
+ tags:
110
+ - participants
111
+ - sampled
112
+ summary: ParticipantsErrorByTypeAndID
113
+ description: If the server is unable to find, create or delete the associated
114
+ FSP of the provided identity, or another processing error occurred, the error
115
+ callback PUT /participants/<Type>/<ID>/error (or PUT /participants/<Type>/<ID>/<SubId>/error)
116
+ is used.
117
+ operationId: ParticipantsErrorByTypeAndIDPut
118
+ parameters:
119
+ - $ref: '#/components/parameters/Type'
120
+ - $ref: '#/components/parameters/ID'
121
+ - $ref: '#/components/parameters/Content-Length'
122
+ - $ref: '#/components/parameters/Content-Type'
123
+ - $ref: '#/components/parameters/Date'
124
+ - $ref: '#/components/parameters/X-Forwarded-For'
125
+ - $ref: '#/components/parameters/FSPIOP-Source'
126
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
127
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
128
+ - $ref: '#/components/parameters/FSPIOP-Signature'
129
+ - $ref: '#/components/parameters/FSPIOP-URI'
130
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
131
+ requestBody:
132
+ content:
133
+ application/json:
134
+ schema:
135
+ $ref: '#/components/schemas/ErrorInformationObject'
136
+ required: true
137
+ responses:
138
+ 200:
139
+ $ref: '#/components/responses/Response200'
140
+ 400:
141
+ $ref: '#/components/responses/ErrorResponse400'
142
+ 401:
143
+ $ref: '#/components/responses/ErrorResponse401'
144
+ 403:
145
+ $ref: '#/components/responses/ErrorResponse403'
146
+ 404:
147
+ $ref: '#/components/responses/ErrorResponse404'
148
+ 405:
149
+ $ref: '#/components/responses/ErrorResponse405'
150
+ 406:
151
+ $ref: '#/components/responses/ErrorResponse406'
152
+ 501:
153
+ $ref: '#/components/responses/ErrorResponse501'
154
+ 503:
155
+ $ref: '#/components/responses/ErrorResponse503'
156
+ /participants/{Type}/{ID}/{SubId}/error:
157
+ put:
158
+ tags:
159
+ - participants
160
+ - sampled
161
+ summary: ParticipantsSubIdErrorByTypeAndID
162
+ description: If the server is unable to find, create or delete the associated
163
+ FSP of the provided identity, or another processing error occurred, the error
164
+ callback PUT /participants/<Type>/<ID>/error (or PUT /participants/<Type>/<ID>/<SubId>/error)
165
+ is used.
166
+ operationId: ParticipantsErrorBySubIdTypeAndIDPut
167
+ parameters:
168
+ - $ref: '#/components/parameters/Type'
169
+ - $ref: '#/components/parameters/ID'
170
+ - $ref: '#/components/parameters/SubId'
171
+ - $ref: '#/components/parameters/Content-Length'
172
+ - $ref: '#/components/parameters/Content-Type'
173
+ - $ref: '#/components/parameters/Date'
174
+ - $ref: '#/components/parameters/X-Forwarded-For'
175
+ - $ref: '#/components/parameters/FSPIOP-Source'
176
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
177
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
178
+ - $ref: '#/components/parameters/FSPIOP-Signature'
179
+ - $ref: '#/components/parameters/FSPIOP-URI'
180
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
181
+ requestBody:
182
+ content:
183
+ application/json:
184
+ schema:
185
+ $ref: '#/components/schemas/ErrorInformationObject'
186
+ required: true
187
+ responses:
188
+ 200:
189
+ $ref: '#/components/responses/Response200'
190
+ 400:
191
+ $ref: '#/components/responses/ErrorResponse400'
192
+ 401:
193
+ $ref: '#/components/responses/ErrorResponse401'
194
+ 403:
195
+ $ref: '#/components/responses/ErrorResponse403'
196
+ 404:
197
+ $ref: '#/components/responses/ErrorResponse404'
198
+ 405:
199
+ $ref: '#/components/responses/ErrorResponse405'
200
+ 406:
201
+ $ref: '#/components/responses/ErrorResponse406'
202
+ 501:
203
+ $ref: '#/components/responses/ErrorResponse501'
204
+ 503:
205
+ $ref: '#/components/responses/ErrorResponse503'
206
+ /participants/{Type}/{ID}/{SubId}:
207
+ parameters:
208
+ - $ref: '#/components/parameters/Type'
209
+ - $ref: '#/components/parameters/ID'
210
+ - $ref: '#/components/parameters/SubId'
211
+ - $ref: '#/components/parameters/Content-Type'
212
+ - $ref: '#/components/parameters/Date'
213
+ - $ref: '#/components/parameters/X-Forwarded-For'
214
+ - $ref: '#/components/parameters/FSPIOP-Source'
215
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
216
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
217
+ - $ref: '#/components/parameters/FSPIOP-Signature'
218
+ - $ref: '#/components/parameters/FSPIOP-URI'
219
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
220
+ get:
221
+ tags:
222
+ - participants
223
+ - sampled
224
+ summary: ParticipantsSubIdByTypeAndID
225
+ description: The HTTP request GET /participants/<Type>/<ID> (or GET /participants/<Type>/<ID>/<SubId>)
226
+ is used to find out in which FSP the requested Party, defined by <Type>, <ID>
227
+ and optionally <SubId>, is located (for example, GET /participants/MSISDN/123456789,
228
+ or GET /participants/BUSINESS/shoecompany/employee1).
229
+ operationId: ParticipantsSubIdByTypeAndIDGet
230
+ parameters:
231
+ - $ref: '#/components/parameters/Accept'
232
+ responses:
233
+ 202:
234
+ $ref: '#/components/responses/Response202'
235
+ 400:
236
+ $ref: '#/components/responses/ErrorResponse400'
237
+ 401:
238
+ $ref: '#/components/responses/ErrorResponse401'
239
+ 403:
240
+ $ref: '#/components/responses/ErrorResponse403'
241
+ 404:
242
+ $ref: '#/components/responses/ErrorResponse404'
243
+ 405:
244
+ $ref: '#/components/responses/ErrorResponse405'
245
+ 406:
246
+ $ref: '#/components/responses/ErrorResponse406'
247
+ 501:
248
+ $ref: '#/components/responses/ErrorResponse501'
249
+ 503:
250
+ $ref: '#/components/responses/ErrorResponse503'
251
+ put:
252
+ tags:
253
+ - participants
254
+ - sampled
255
+ summary: ParticipantsSubIdByTypeAndID
256
+ description: The callback PUT /participants/<Type>/<ID> (or PUT /participants/<Type>/<ID>/<SubId>)
257
+ is used to inform the client of a successful result of the lookup, creation,
258
+ or deletion of the FSP information related to the Party. If the FSP information
259
+ is deleted, the fspId element should be empty; otherwise the element should
260
+ include the FSP information for the Party.
261
+ operationId: ParticipantsSubIdByTypeAndIDPut
262
+ parameters:
263
+ - $ref: '#/components/parameters/Content-Length'
264
+ requestBody:
265
+ content:
266
+ application/json:
267
+ schema:
268
+ $ref: '#/components/schemas/ParticipantsTypeIDPutResponse'
269
+ required: true
270
+ responses:
271
+ 200:
272
+ $ref: '#/components/responses/Response200'
273
+ 400:
274
+ $ref: '#/components/responses/ErrorResponse400'
275
+ 401:
276
+ $ref: '#/components/responses/ErrorResponse401'
277
+ 403:
278
+ $ref: '#/components/responses/ErrorResponse403'
279
+ 404:
280
+ $ref: '#/components/responses/ErrorResponse404'
281
+ 405:
282
+ $ref: '#/components/responses/ErrorResponse405'
283
+ 406:
284
+ $ref: '#/components/responses/ErrorResponse406'
285
+ 501:
286
+ $ref: '#/components/responses/ErrorResponse501'
287
+ 503:
288
+ $ref: '#/components/responses/ErrorResponse503'
289
+ post:
290
+ tags:
291
+ - participants
292
+ - sampled
293
+ summary: ParticipantsSubIdByTypeAndID
294
+ description: The HTTP request POST /participants/<Type>/<ID> (or POST /participants/<Type>/<ID>/<SubId>)
295
+ is used to create information in the server regarding the provided identity,
296
+ defined by <Type>, <ID>, and optionally <SubId> (for example, POST /participants/MSISDN/123456789
297
+ or POST /participants/BUSINESS/shoecompany/employee1).
298
+ operationId: ParticipantsSubIdByTypeAndIDPost
299
+ parameters:
300
+ - $ref: '#/components/parameters/Accept'
301
+ - $ref: '#/components/parameters/Content-Length'
302
+ requestBody:
303
+ content:
304
+ application/json:
305
+ schema:
306
+ $ref: '#/components/schemas/ParticipantsTypeIDSubIDPostRequest'
307
+ required: true
308
+ responses:
309
+ 202:
310
+ $ref: '#/components/responses/Response202'
311
+ 400:
312
+ $ref: '#/components/responses/ErrorResponse400'
313
+ 401:
314
+ $ref: '#/components/responses/ErrorResponse401'
315
+ 403:
316
+ $ref: '#/components/responses/ErrorResponse403'
317
+ 404:
318
+ $ref: '#/components/responses/ErrorResponse404'
319
+ 405:
320
+ $ref: '#/components/responses/ErrorResponse405'
321
+ 406:
322
+ $ref: '#/components/responses/ErrorResponse406'
323
+ 501:
324
+ $ref: '#/components/responses/ErrorResponse501'
325
+ 503:
326
+ $ref: '#/components/responses/ErrorResponse503'
327
+ delete:
328
+ tags:
329
+ - participants
330
+ - sampled
331
+ summary: ParticipantsSubIdByTypeAndID
332
+ description: The HTTP request DELETE /participants/<Type>/<ID> (or DELETE /participants/<Type>/<ID>/<SubId>)
333
+ is used to delete information in the server regarding the provided identity,
334
+ defined by <Type> and <ID>) (for example, DELETE /participants/MSISDN/123456789),
335
+ and optionally <SubId>. This HTTP request should support a query string to
336
+ delete FSP information regarding a specific currency only. To delete a specific
337
+ currency only, the HTTP request DELETE /participants/<Type>/<ID>?currency=XYZ
338
+ should be used, where XYZ is the requested currency. Note - The Account Lookup
339
+ System should verify that it is the Party’s current FSP that is deleting the
340
+ FSP information.
341
+ operationId: ParticipantsSubIdByTypeAndIDDelete
342
+ parameters:
343
+ - $ref: '#/components/parameters/Accept'
344
+ responses:
345
+ 202:
346
+ $ref: '#/components/responses/Response202'
347
+ 400:
348
+ $ref: '#/components/responses/ErrorResponse400'
349
+ 401:
350
+ $ref: '#/components/responses/ErrorResponse401'
351
+ 403:
352
+ $ref: '#/components/responses/ErrorResponse403'
353
+ 404:
354
+ $ref: '#/components/responses/ErrorResponse404'
355
+ 405:
356
+ $ref: '#/components/responses/ErrorResponse405'
357
+ 406:
358
+ $ref: '#/components/responses/ErrorResponse406'
359
+ 501:
360
+ $ref: '#/components/responses/ErrorResponse501'
361
+ 503:
362
+ $ref: '#/components/responses/ErrorResponse503'
363
+ /participants/{Type}/{ID}:
364
+ parameters:
365
+ - $ref: '#/components/parameters/Type'
366
+ - $ref: '#/components/parameters/ID'
367
+ - $ref: '#/components/parameters/Content-Type'
368
+ - $ref: '#/components/parameters/Date'
369
+ - $ref: '#/components/parameters/X-Forwarded-For'
370
+ - $ref: '#/components/parameters/FSPIOP-Source'
371
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
372
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
373
+ - $ref: '#/components/parameters/FSPIOP-Signature'
374
+ - $ref: '#/components/parameters/FSPIOP-URI'
375
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
376
+ get:
377
+ tags:
378
+ - participants
379
+ - sampled
380
+ summary: ParticipantsByTypeAndID
381
+ description: The HTTP request GET /participants/<Type>/<ID> (or GET /participants/<Type>/<ID>/<SubId>)
382
+ is used to find out in which FSP the requested Party, defined by <Type>, <ID>
383
+ and optionally <SubId>, is located (for example, GET /participants/MSISDN/123456789,
384
+ or GET /participants/BUSINESS/shoecompany/employee1).
385
+ operationId: ParticipantsByTypeAndIDGet
386
+ parameters:
387
+ - $ref: '#/components/parameters/Accept'
388
+ responses:
389
+ 202:
390
+ $ref: '#/components/responses/Response202'
391
+ 400:
392
+ $ref: '#/components/responses/ErrorResponse400'
393
+ 401:
394
+ $ref: '#/components/responses/ErrorResponse401'
395
+ 403:
396
+ $ref: '#/components/responses/ErrorResponse403'
397
+ 404:
398
+ $ref: '#/components/responses/ErrorResponse404'
399
+ 405:
400
+ $ref: '#/components/responses/ErrorResponse405'
401
+ 406:
402
+ $ref: '#/components/responses/ErrorResponse406'
403
+ 501:
404
+ $ref: '#/components/responses/ErrorResponse501'
405
+ 503:
406
+ $ref: '#/components/responses/ErrorResponse503'
407
+ put:
408
+ tags:
409
+ - participants
410
+ - sampled
411
+ summary: ParticipantsByTypeAndID
412
+ description: The callback PUT /participants/<Type>/<ID> (or PUT /participants/<Type>/<ID>/<SubId>)
413
+ is used to inform the client of a successful result of the lookup, creation,
414
+ or deletion of the FSP information related to the Party. If the FSP information
415
+ is deleted, the fspId element should be empty; otherwise the element should
416
+ include the FSP information for the Party.
417
+ operationId: ParticipantsByTypeAndIDPut
418
+ parameters:
419
+ - $ref: '#/components/parameters/Accept-Optional'
420
+ - $ref: '#/components/parameters/Content-Length'
421
+ requestBody:
422
+ content:
423
+ application/json:
424
+ schema:
425
+ $ref: '#/components/schemas/ParticipantsTypeIDPutResponse'
426
+ required: true
427
+ responses:
428
+ 200:
429
+ $ref: '#/components/responses/Response200'
430
+ 400:
431
+ $ref: '#/components/responses/ErrorResponse400'
432
+ 401:
433
+ $ref: '#/components/responses/ErrorResponse401'
434
+ 403:
435
+ $ref: '#/components/responses/ErrorResponse403'
436
+ 404:
437
+ $ref: '#/components/responses/ErrorResponse404'
438
+ 405:
439
+ $ref: '#/components/responses/ErrorResponse405'
440
+ 406:
441
+ $ref: '#/components/responses/ErrorResponse406'
442
+ 501:
443
+ $ref: '#/components/responses/ErrorResponse501'
444
+ 503:
445
+ $ref: '#/components/responses/ErrorResponse503'
446
+ post:
447
+ tags:
448
+ - participants
449
+ - sampled
450
+ summary: ParticipantsByIDAndType
451
+ description: The HTTP request POST /participants/<Type>/<ID> (or POST /participants/<Type>/<ID>/<SubId>)
452
+ is used to create information in the server regarding the provided identity,
453
+ defined by <Type>, <ID>, and optionally <SubId> (for example, POST /participants/MSISDN/123456789
454
+ or POST /participants/BUSINESS/shoecompany/employee1).
455
+ operationId: ParticipantsByIDAndTypePost
456
+ parameters:
457
+ - $ref: '#/components/parameters/Accept'
458
+ - $ref: '#/components/parameters/Content-Length'
459
+ requestBody:
460
+ content:
461
+ application/json:
462
+ schema:
463
+ $ref: '#/components/schemas/ParticipantsTypeIDSubIDPostRequest'
464
+ required: true
465
+ responses:
466
+ 202:
467
+ $ref: '#/components/responses/Response202'
468
+ 400:
469
+ $ref: '#/components/responses/ErrorResponse400'
470
+ 401:
471
+ $ref: '#/components/responses/ErrorResponse401'
472
+ 403:
473
+ $ref: '#/components/responses/ErrorResponse403'
474
+ 404:
475
+ $ref: '#/components/responses/ErrorResponse404'
476
+ 405:
477
+ $ref: '#/components/responses/ErrorResponse405'
478
+ 406:
479
+ $ref: '#/components/responses/ErrorResponse406'
480
+ 501:
481
+ $ref: '#/components/responses/ErrorResponse501'
482
+ 503:
483
+ $ref: '#/components/responses/ErrorResponse503'
484
+ delete:
485
+ tags:
486
+ - participants
487
+ - sampled
488
+ summary: ParticipantsByTypeAndID
489
+ description: The HTTP request DELETE /participants/<Type>/<ID> (or DELETE /participants/<Type>/<ID>/<SubId>)
490
+ is used to delete information in the server regarding the provided identity,
491
+ defined by <Type> and <ID>) (for example, DELETE /participants/MSISDN/123456789),
492
+ and optionally <SubId>. This HTTP request should support a query string to
493
+ delete FSP information regarding a specific currency only. To delete a specific
494
+ currency only, the HTTP request DELETE /participants/<Type>/<ID>?currency=XYZ
495
+ should be used, where XYZ is the requested currency. Note - The Account Lookup
496
+ System should verify that it is the Party’s current FSP that is deleting the
497
+ FSP information.
498
+ operationId: ParticipantsByTypeAndIDDelete
499
+ parameters:
500
+ - $ref: '#/components/parameters/Accept'
501
+ responses:
502
+ 202:
503
+ $ref: '#/components/responses/Response202'
504
+ 400:
505
+ $ref: '#/components/responses/ErrorResponse400'
506
+ 401:
507
+ $ref: '#/components/responses/ErrorResponse401'
508
+ 403:
509
+ $ref: '#/components/responses/ErrorResponse403'
510
+ 404:
511
+ $ref: '#/components/responses/ErrorResponse404'
512
+ 405:
513
+ $ref: '#/components/responses/ErrorResponse405'
514
+ 406:
515
+ $ref: '#/components/responses/ErrorResponse406'
516
+ 501:
517
+ $ref: '#/components/responses/ErrorResponse501'
518
+ 503:
519
+ $ref: '#/components/responses/ErrorResponse503'
520
+ /participants:
521
+ post:
522
+ tags:
523
+ - participants
524
+ - sampled
525
+ summary: Participants
526
+ description: The HTTP request POST /participants is used to create information
527
+ in the server regarding the provided list of identities. This request should
528
+ be used for bulk creation of FSP information for more than one Party. The
529
+ optional currency parameter should indicate that each provided Party supports
530
+ the currency
531
+ operationId: ParticipantsPost
532
+ parameters:
533
+ - $ref: '#/components/parameters/Content-Length'
534
+ - $ref: '#/components/parameters/Content-Type'
535
+ - $ref: '#/components/parameters/Accept'
536
+ - $ref: '#/components/parameters/Date'
537
+ - $ref: '#/components/parameters/X-Forwarded-For'
538
+ - $ref: '#/components/parameters/FSPIOP-Source'
539
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
540
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
541
+ - $ref: '#/components/parameters/FSPIOP-Signature'
542
+ - $ref: '#/components/parameters/FSPIOP-URI'
543
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
544
+ requestBody:
545
+ content:
546
+ application/json:
547
+ schema:
548
+ $ref: '#/components/schemas/ParticipantsPostRequest'
549
+ required: true
550
+ responses:
551
+ 202:
552
+ $ref: '#/components/responses/Response202'
553
+ 400:
554
+ $ref: '#/components/responses/ErrorResponse400'
555
+ 401:
556
+ $ref: '#/components/responses/ErrorResponse401'
557
+ 403:
558
+ $ref: '#/components/responses/ErrorResponse403'
559
+ 404:
560
+ $ref: '#/components/responses/ErrorResponse404'
561
+ 405:
562
+ $ref: '#/components/responses/ErrorResponse405'
563
+ 406:
564
+ $ref: '#/components/responses/ErrorResponse406'
565
+ 501:
566
+ $ref: '#/components/responses/ErrorResponse501'
567
+ 503:
568
+ $ref: '#/components/responses/ErrorResponse503'
569
+ /parties/{Type}/{ID}:
570
+ parameters:
571
+ - $ref: '#/components/parameters/Type'
572
+ - $ref: '#/components/parameters/ID'
573
+ - $ref: '#/components/parameters/Content-Type'
574
+ - $ref: '#/components/parameters/Date'
575
+ - $ref: '#/components/parameters/X-Forwarded-For'
576
+ - $ref: '#/components/parameters/FSPIOP-Source'
577
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
578
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
579
+ - $ref: '#/components/parameters/FSPIOP-Signature'
580
+ - $ref: '#/components/parameters/FSPIOP-URI'
581
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
582
+ get:
583
+ tags:
584
+ - parties
585
+ - sampled
586
+ summary: PartiesByTypeAndID
587
+ description: The HTTP request GET /parties/<Type>/<ID> (or GET /parties/<Type>/<ID>/<SubId>)
588
+ is used to lookup information regarding the requested Party, defined by <Type>,
589
+ <ID> and optionally <SubId> (for example, GET /parties/MSISDN/123456789, or
590
+ GET /parties/BUSINESS/shoecompany/employee1).
591
+ operationId: PartiesByTypeAndIDGet
592
+ parameters:
593
+ - $ref: '#/components/parameters/Accept'
594
+ responses:
595
+ 202:
596
+ $ref: '#/components/responses/Response202'
597
+ 400:
598
+ $ref: '#/components/responses/ErrorResponse400'
599
+ 401:
600
+ $ref: '#/components/responses/ErrorResponse401'
601
+ 403:
602
+ $ref: '#/components/responses/ErrorResponse403'
603
+ 404:
604
+ $ref: '#/components/responses/ErrorResponse404'
605
+ 405:
606
+ $ref: '#/components/responses/ErrorResponse405'
607
+ 406:
608
+ $ref: '#/components/responses/ErrorResponse406'
609
+ 501:
610
+ $ref: '#/components/responses/ErrorResponse501'
611
+ 503:
612
+ $ref: '#/components/responses/ErrorResponse503'
613
+ put:
614
+ tags:
615
+ - parties
616
+ - sampled
617
+ summary: PartiesByTypeAndID2
618
+ description: The callback PUT /parties/<Type>/<ID> (or PUT /parties/<Type>/<ID>/<SubId>)
619
+ is used to inform the client of a successful result of the Party information
620
+ lookup.
621
+ operationId: PartiesByTypeAndIDPut
622
+ parameters:
623
+ - $ref: '#/components/parameters/Accept-Optional'
624
+ - $ref: '#/components/parameters/Content-Length'
625
+ requestBody:
626
+ content:
627
+ application/json:
628
+ schema:
629
+ $ref: '#/components/schemas/PartiesTypeIDPutResponse'
630
+ required: true
631
+ responses:
632
+ 200:
633
+ $ref: '#/components/responses/Response200'
634
+ 400:
635
+ $ref: '#/components/responses/ErrorResponse400'
636
+ 401:
637
+ $ref: '#/components/responses/ErrorResponse401'
638
+ 403:
639
+ $ref: '#/components/responses/ErrorResponse403'
640
+ 404:
641
+ $ref: '#/components/responses/ErrorResponse404'
642
+ 405:
643
+ $ref: '#/components/responses/ErrorResponse405'
644
+ 406:
645
+ $ref: '#/components/responses/ErrorResponse406'
646
+ 501:
647
+ $ref: '#/components/responses/ErrorResponse501'
648
+ 503:
649
+ $ref: '#/components/responses/ErrorResponse503'
650
+ /parties/{Type}/{ID}/error:
651
+ put:
652
+ tags:
653
+ - parties
654
+ - sampled
655
+ summary: PartiesErrorByTypeAndID
656
+ description: If the server is unable to find Party information of the provided
657
+ identity, or another processing error occurred, the error callback PUT /parties/<Type>/<ID>/error
658
+ (or PUT /parties/<Type>/<ID>/<SubId>/error) is used.
659
+ operationId: PartiesErrorByTypeAndIDPut
660
+ parameters:
661
+ - $ref: '#/components/parameters/Accept-Optional'
662
+ - $ref: '#/components/parameters/Type'
663
+ - $ref: '#/components/parameters/ID'
664
+ - $ref: '#/components/parameters/Content-Length'
665
+ - $ref: '#/components/parameters/Content-Type'
666
+ - $ref: '#/components/parameters/Date'
667
+ - $ref: '#/components/parameters/X-Forwarded-For'
668
+ - $ref: '#/components/parameters/FSPIOP-Source'
669
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
670
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
671
+ - $ref: '#/components/parameters/FSPIOP-Signature'
672
+ - $ref: '#/components/parameters/FSPIOP-URI'
673
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
674
+ requestBody:
675
+ content:
676
+ application/json:
677
+ schema:
678
+ $ref: '#/components/schemas/ErrorInformationObject'
679
+ required: true
680
+ responses:
681
+ 200:
682
+ $ref: '#/components/responses/Response200'
683
+ 400:
684
+ $ref: '#/components/responses/ErrorResponse400'
685
+ 401:
686
+ $ref: '#/components/responses/ErrorResponse401'
687
+ 403:
688
+ $ref: '#/components/responses/ErrorResponse403'
689
+ 404:
690
+ $ref: '#/components/responses/ErrorResponse404'
691
+ 405:
692
+ $ref: '#/components/responses/ErrorResponse405'
693
+ 406:
694
+ $ref: '#/components/responses/ErrorResponse406'
695
+ 501:
696
+ $ref: '#/components/responses/ErrorResponse501'
697
+ 503:
698
+ $ref: '#/components/responses/ErrorResponse503'
699
+ /parties/{Type}/{ID}/{SubId}:
700
+ parameters:
701
+ - $ref: '#/components/parameters/Type'
702
+ - $ref: '#/components/parameters/ID'
703
+ - $ref: '#/components/parameters/SubId'
704
+ - $ref: '#/components/parameters/Content-Type'
705
+ - $ref: '#/components/parameters/Date'
706
+ - $ref: '#/components/parameters/X-Forwarded-For'
707
+ - $ref: '#/components/parameters/FSPIOP-Source'
708
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
709
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
710
+ - $ref: '#/components/parameters/FSPIOP-Signature'
711
+ - $ref: '#/components/parameters/FSPIOP-URI'
712
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
713
+ get:
714
+ tags:
715
+ - parties
716
+ - sampled
717
+ summary: PartiesSubIdByTypeAndID
718
+ description: The HTTP request GET /parties/<Type>/<ID> (or GET /parties/<Type>/<ID>/<SubId>)
719
+ is used to lookup information regarding the requested Party, defined by <Type>,
720
+ <ID> and optionally <SubId> (for example, GET /parties/MSISDN/123456789, or
721
+ GET /parties/BUSINESS/shoecompany/employee1).
722
+ operationId: PartiesBySubIdTypeAndIDGet
723
+ parameters:
724
+ - $ref: '#/components/parameters/Accept'
725
+ responses:
726
+ 202:
727
+ $ref: '#/components/responses/Response202'
728
+ 400:
729
+ $ref: '#/components/responses/ErrorResponse400'
730
+ 401:
731
+ $ref: '#/components/responses/ErrorResponse401'
732
+ 403:
733
+ $ref: '#/components/responses/ErrorResponse403'
734
+ 404:
735
+ $ref: '#/components/responses/ErrorResponse404'
736
+ 405:
737
+ $ref: '#/components/responses/ErrorResponse405'
738
+ 406:
739
+ $ref: '#/components/responses/ErrorResponse406'
740
+ 501:
741
+ $ref: '#/components/responses/ErrorResponse501'
742
+ 503:
743
+ $ref: '#/components/responses/ErrorResponse503'
744
+ put:
745
+ tags:
746
+ - parties
747
+ - sampled
748
+ summary: PartiesSubIdByTypeAndID
749
+ description: The callback PUT /parties/<Type>/<ID> (or PUT /parties/<Type>/<ID>/<SubId>)
750
+ is used to inform the client of a successful result of the Party information
751
+ lookup.
752
+ operationId: PartiesSubIdByTypeAndIDPut
753
+ parameters:
754
+ - $ref: '#/components/parameters/Accept-Optional'
755
+ - $ref: '#/components/parameters/Content-Length'
756
+ requestBody:
757
+ content:
758
+ application/json:
759
+ schema:
760
+ $ref: '#/components/schemas/PartiesTypeIDPutResponse'
761
+ required: true
762
+ responses:
763
+ 200:
764
+ $ref: '#/components/responses/Response200'
765
+ 400:
766
+ $ref: '#/components/responses/ErrorResponse400'
767
+ 401:
768
+ $ref: '#/components/responses/ErrorResponse401'
769
+ 403:
770
+ $ref: '#/components/responses/ErrorResponse403'
771
+ 404:
772
+ $ref: '#/components/responses/ErrorResponse404'
773
+ 405:
774
+ $ref: '#/components/responses/ErrorResponse405'
775
+ 406:
776
+ $ref: '#/components/responses/ErrorResponse406'
777
+ 501:
778
+ $ref: '#/components/responses/ErrorResponse501'
779
+ 503:
780
+ $ref: '#/components/responses/ErrorResponse503'
781
+ /parties/{Type}/{ID}/{SubId}/error:
782
+ put:
783
+ tags:
784
+ - parties
785
+ - sampled
786
+ summary: PartiesSubIdErrorByTypeAndID
787
+ description: If the server is unable to find Party information of the provided
788
+ identity, or another processing error occurred, the error callback PUT /parties/<Type>/<ID>/error
789
+ (or PUT /parties/<Type>/<ID>/<SubId>/error) is used.
790
+ operationId: PartiesErrorBySubIdTypeAndIDPut
791
+ parameters:
792
+ - $ref: '#/components/parameters/Accept-Optional'
793
+ - $ref: '#/components/parameters/Type'
794
+ - $ref: '#/components/parameters/ID'
795
+ - $ref: '#/components/parameters/SubId'
796
+ - $ref: '#/components/parameters/Content-Length'
797
+ - $ref: '#/components/parameters/Content-Type'
798
+ - $ref: '#/components/parameters/Date'
799
+ - $ref: '#/components/parameters/X-Forwarded-For'
800
+ - $ref: '#/components/parameters/FSPIOP-Source'
801
+ - $ref: '#/components/parameters/FSPIOP-Destination-Optional'
802
+ - $ref: '#/components/parameters/FSPIOP-Encryption'
803
+ - $ref: '#/components/parameters/FSPIOP-Signature'
804
+ - $ref: '#/components/parameters/FSPIOP-URI'
805
+ - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
806
+ requestBody:
807
+ content:
808
+ application/json:
809
+ schema:
810
+ $ref: '#/components/schemas/ErrorInformationObject'
811
+ required: true
812
+ responses:
813
+ 200:
814
+ $ref: '#/components/responses/Response200'
815
+ 400:
816
+ $ref: '#/components/responses/ErrorResponse400'
817
+ 401:
818
+ $ref: '#/components/responses/ErrorResponse401'
819
+ 403:
820
+ $ref: '#/components/responses/ErrorResponse403'
821
+ 404:
822
+ $ref: '#/components/responses/ErrorResponse404'
823
+ 405:
824
+ $ref: '#/components/responses/ErrorResponse405'
825
+ 406:
826
+ $ref: '#/components/responses/ErrorResponse406'
827
+ 501:
828
+ $ref: '#/components/responses/ErrorResponse501'
829
+ 503:
830
+ $ref: '#/components/responses/ErrorResponse503'
831
+ /health:
832
+ get:
833
+ tags:
834
+ - health
835
+ summary: Get health
836
+ description: The HTTP request GET /health is used to return the current status
837
+ of the ALS API.
838
+ operationId: HealthGet
839
+ responses:
840
+ 200:
841
+ $ref: '#/components/responses/ResponseHealth200'
842
+ 400:
843
+ $ref: '#/components/responses/ErrorResponse400'
844
+ 401:
845
+ $ref: '#/components/responses/ErrorResponse401'
846
+ 403:
847
+ $ref: '#/components/responses/ErrorResponse403'
848
+ 404:
849
+ $ref: '#/components/responses/ErrorResponse404'
850
+ 405:
851
+ $ref: '#/components/responses/ErrorResponse405'
852
+ 406:
853
+ $ref: '#/components/responses/ErrorResponse406'
854
+ 501:
855
+ $ref: '#/components/responses/ErrorResponse501'
856
+ 503:
857
+ $ref: '#/components/responses/ErrorResponse503'
858
+ /endpointcache:
859
+ delete:
860
+ tags:
861
+ - cache
862
+ - sampled
863
+ summary: Endpoint Cache
864
+ description: The HTTP request DELETE /endpointcache is used to reset the endpoint
865
+ cache by performing an stopCache and initializeCache the Admin API.
866
+ operationId: EndpointCacheDelete
867
+ parameters:
868
+ - $ref: '#/components/parameters/Date'
869
+ responses:
870
+ 202:
871
+ $ref: '#/components/responses/Response202'
872
+ 400:
873
+ $ref: '#/components/responses/ErrorResponse400'
874
+ 401:
875
+ $ref: '#/components/responses/ErrorResponse401'
876
+ 403:
877
+ $ref: '#/components/responses/ErrorResponse403'
878
+ 404:
879
+ $ref: '#/components/responses/ErrorResponse404'
880
+ 405:
881
+ $ref: '#/components/responses/ErrorResponse405'
882
+ 406:
883
+ $ref: '#/components/responses/ErrorResponse406'
884
+ 501:
885
+ $ref: '#/components/responses/ErrorResponse501'
886
+ 503:
887
+ $ref: '#/components/responses/ErrorResponse503'
888
+ components:
889
+ schemas:
890
+ CorrelationId:
891
+ title: CorrelationId
892
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
893
+ type: string
894
+ description: Identifier that correlates all messages of the same sequence. The
895
+ API data type UUID (Universally Unique Identifier) is a JSON String in canonical
896
+ format, conforming to RFC 4122, that is restricted by a regular expression
897
+ for interoperability reasons. An UUID is always 36 characters long, 32 hexadecimal
898
+ symbols and 4 dashes (‘-‘).
899
+ Currency:
900
+ title: CurrencyEnum
901
+ maxLength: 3
902
+ minLength: 3
903
+ type: string
904
+ description: The currency codes defined in ISO 4217 as three-letter alphabetic
905
+ codes are used as the standard naming representation for currencies.
906
+ enum:
907
+ - AED
908
+ - AFN
909
+ - ALL
910
+ - AMD
911
+ - ANG
912
+ - AOA
913
+ - ARS
914
+ - AUD
915
+ - AWG
916
+ - AZN
917
+ - BAM
918
+ - BBD
919
+ - BDT
920
+ - BGN
921
+ - BHD
922
+ - BIF
923
+ - BMD
924
+ - BND
925
+ - BOB
926
+ - BRL
927
+ - BSD
928
+ - BTN
929
+ - BWP
930
+ - BYN
931
+ - BZD
932
+ - CAD
933
+ - CDF
934
+ - CHF
935
+ - CLP
936
+ - CNY
937
+ - COP
938
+ - CRC
939
+ - CUC
940
+ - CUP
941
+ - CVE
942
+ - CZK
943
+ - DJF
944
+ - DKK
945
+ - DOP
946
+ - DZD
947
+ - EGP
948
+ - ERN
949
+ - ETB
950
+ - EUR
951
+ - FJD
952
+ - FKP
953
+ - GBP
954
+ - GEL
955
+ - GGP
956
+ - GHS
957
+ - GIP
958
+ - GMD
959
+ - GNF
960
+ - GTQ
961
+ - GYD
962
+ - HKD
963
+ - HNL
964
+ - HRK
965
+ - HTG
966
+ - HUF
967
+ - IDR
968
+ - ILS
969
+ - IMP
970
+ - INR
971
+ - IQD
972
+ - IRR
973
+ - ISK
974
+ - JEP
975
+ - JMD
976
+ - JOD
977
+ - JPY
978
+ - KES
979
+ - KGS
980
+ - KHR
981
+ - KMF
982
+ - KPW
983
+ - KRW
984
+ - KWD
985
+ - KYD
986
+ - KZT
987
+ - LAK
988
+ - LBP
989
+ - LKR
990
+ - LRD
991
+ - LSL
992
+ - LYD
993
+ - MAD
994
+ - MDL
995
+ - MGA
996
+ - MKD
997
+ - MMK
998
+ - MNT
999
+ - MOP
1000
+ - MRO
1001
+ - MUR
1002
+ - MVR
1003
+ - MWK
1004
+ - MXN
1005
+ - MYR
1006
+ - MZN
1007
+ - NAD
1008
+ - NGN
1009
+ - NIO
1010
+ - NOK
1011
+ - NPR
1012
+ - NZD
1013
+ - OMR
1014
+ - PAB
1015
+ - PEN
1016
+ - PGK
1017
+ - PHP
1018
+ - PKR
1019
+ - PLN
1020
+ - PYG
1021
+ - QAR
1022
+ - RON
1023
+ - RSD
1024
+ - RUB
1025
+ - RWF
1026
+ - SAR
1027
+ - SBD
1028
+ - SCR
1029
+ - SDG
1030
+ - SEK
1031
+ - SGD
1032
+ - SHP
1033
+ - SLL
1034
+ - SOS
1035
+ - SPL
1036
+ - SRD
1037
+ - STD
1038
+ - SVC
1039
+ - SYP
1040
+ - SZL
1041
+ - THB
1042
+ - TJS
1043
+ - TMT
1044
+ - TND
1045
+ - TOP
1046
+ - TRY
1047
+ - TTD
1048
+ - TVD
1049
+ - TWD
1050
+ - TZS
1051
+ - UAH
1052
+ - UGX
1053
+ - USD
1054
+ - UYU
1055
+ - UZS
1056
+ - VEF
1057
+ - VND
1058
+ - VUV
1059
+ - WST
1060
+ - XAF
1061
+ - XCD
1062
+ - XDR
1063
+ - XOF
1064
+ - XPF
1065
+ - XTS
1066
+ - XXX
1067
+ - YER
1068
+ - ZAR
1069
+ - ZMW
1070
+ - ZWD
1071
+ Date:
1072
+ title: Date
1073
+ pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
1074
+ type: string
1075
+ description: The API data type Date is a JSON String in a lexical format that
1076
+ is restricted by a regular expression for interoperability reasons. This format,
1077
+ as specified in ISO 8601, contains a date only. A more readable version of
1078
+ the format is yyyy-MM-dd. Examples - "1982-05-23", "1987-08-05”
1079
+ DateOfBirth:
1080
+ title: DateofBirth (type Date)
1081
+ pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
1082
+ type: string
1083
+ description: Date of Birth of the Party.
1084
+ ErrorCode:
1085
+ title: ErrorCode
1086
+ pattern: ^[1-9]\d{3}$
1087
+ type: string
1088
+ description: The API data type ErrorCode is a JSON String of four characters,
1089
+ consisting of digits only. Negative numbers are not allowed. A leading zero
1090
+ is not allowed. Each error code in the API is a four-digit number, for example,
1091
+ 1234, where the first number (1 in the example) represents the high-level
1092
+ error category, the second number (2 in the example) represents the low-level
1093
+ error category, and the last two numbers (34 in the example) represents the
1094
+ specific error.
1095
+ ErrorDescription:
1096
+ title: ErrorDescription
1097
+ maxLength: 128
1098
+ minLength: 1
1099
+ type: string
1100
+ description: Error description string.
1101
+ ExtensionKey:
1102
+ title: ExtensionKey
1103
+ maxLength: 32
1104
+ minLength: 1
1105
+ type: string
1106
+ description: Extension key.
1107
+ ExtensionValue:
1108
+ title: ExtensionValue
1109
+ maxLength: 128
1110
+ minLength: 1
1111
+ type: string
1112
+ description: Extension value.
1113
+ FspId:
1114
+ title: FspId
1115
+ maxLength: 32
1116
+ minLength: 1
1117
+ type: string
1118
+ description: FSP identifier.
1119
+ HealthStatusType:
1120
+ title: HealthStatusType
1121
+ type: string
1122
+ description: Below are the allowed values for the enumeration HealthStatusType
1123
+ - OK - DOWN
1124
+ enum:
1125
+ - OK
1126
+ - DOWN
1127
+ MerchantClassificationCode:
1128
+ title: MerchantClassificationCode
1129
+ pattern: ^[\d]{1,4}$
1130
+ type: string
1131
+ description: A limited set of pre-defined numbers. This list would be a limited
1132
+ set of numbers identifying a set of popular merchant types like School Fees,
1133
+ Pubs and Restaurants, Groceries, etc.
1134
+ PartyIdType:
1135
+ title: PartyIdTypeEnum
1136
+ type: string
1137
+ description: Below are the allowed values for the enumeration - MSISDN An MSISDN
1138
+ (Mobile Station International Subscriber Directory Number, that is, the phone
1139
+ number) is used as reference to a participant. The MSISDN identifier should
1140
+ be in international format according to the ITU-T E.164 standard. Optionally,
1141
+ the MSISDN may be prefixed by a single plus sign, indicating the international
1142
+ prefix. - EMAIL An email is used as reference to a participant. The format
1143
+ of the email should be according to the informational RFC 3696. - PERSONAL_ID
1144
+ A personal identifier is used as reference to a participant. Examples of personal
1145
+ identification are passport number, birth certificate number, and national
1146
+ registration number. The identifier number is added in the PartyIdentifier
1147
+ element. The personal identifier type is added in the PartySubIdOrType element.
1148
+ - BUSINESS A specific Business (for example, an organization or a company)
1149
+ is used as reference to a participant. The BUSINESS identifier can be in any
1150
+ format. To make a transaction connected to a specific username or bill number
1151
+ in a Business, the PartySubIdOrType element should be used. - DEVICE A specific
1152
+ device (for example, a POS or ATM) ID connected to a specific business or
1153
+ organization is used as reference to a Party. For referencing a specific device
1154
+ under a specific business or organization, use the PartySubIdOrType element.
1155
+ - ACCOUNT_ID A bank account number or FSP account ID should be used as reference
1156
+ to a participant. The ACCOUNT_ID identifier can be in any format, as formats
1157
+ can greatly differ depending on country and FSP. - IBAN A bank account number
1158
+ or FSP account ID is used as reference to a participant. The IBAN identifier
1159
+ can consist of up to 34 alphanumeric characters and should be entered without
1160
+ whitespace. - ALIAS An alias is used as reference to a participant. The alias
1161
+ should be created in the FSP as an alternative reference to an account owner.
1162
+ Another example of an alias is a username in the FSP system. The ALIAS identifier
1163
+ can be in any format. It is also possible to use the PartySubIdOrType element
1164
+ for identifying an account under an Alias defined by the PartyIdentifier.
1165
+ - CONSENT - TBD
1166
+ - THIRD_PARTY_LINK - TBD
1167
+ enum:
1168
+ - MSISDN
1169
+ - EMAIL
1170
+ - PERSONAL_ID
1171
+ - BUSINESS
1172
+ - DEVICE
1173
+ - ACCOUNT_ID
1174
+ - IBAN
1175
+ - ALIAS
1176
+ - CONSENT
1177
+ - THIRD_PARTY_LINK
1178
+ ErrorInformation:
1179
+ title: ErrorInformation
1180
+ required:
1181
+ - errorCode
1182
+ - errorDescription
1183
+ type: object
1184
+ properties:
1185
+ errorCode:
1186
+ $ref: '#/components/schemas/ErrorCode'
1187
+ errorDescription:
1188
+ $ref: '#/components/schemas/ErrorDescription'
1189
+ extensionList:
1190
+ $ref: '#/components/schemas/ExtensionList'
1191
+ description: Data model for the complex type ErrorInformation.
1192
+ ErrorInformationObject:
1193
+ title: ErrorInformationObject
1194
+ required:
1195
+ - errorInformation
1196
+ type: object
1197
+ properties:
1198
+ errorInformation:
1199
+ $ref: '#/components/schemas/ErrorInformation'
1200
+ description: Data model for the complex type object that contains ErrorInformation.
1201
+ ErrorInformationResponse:
1202
+ title: ErrorInformationResponse
1203
+ type: object
1204
+ properties:
1205
+ errorInformation:
1206
+ $ref: '#/components/schemas/ErrorInformation'
1207
+ description: Data model for the complex type object that contains an optional
1208
+ element ErrorInformation used along with 4xx and 5xx responses.
1209
+ Extension:
1210
+ title: Extension
1211
+ required:
1212
+ - key
1213
+ - value
1214
+ type: object
1215
+ properties:
1216
+ key:
1217
+ $ref: '#/components/schemas/ExtensionKey'
1218
+ value:
1219
+ $ref: '#/components/schemas/ExtensionValue'
1220
+ description: Data model for the complex type Extension
1221
+ ExtensionList:
1222
+ title: ExtensionList
1223
+ required:
1224
+ - extension
1225
+ type: object
1226
+ properties:
1227
+ extension:
1228
+ maxItems: 16
1229
+ minItems: 1
1230
+ type: array
1231
+ description: Number of Extension elements
1232
+ items:
1233
+ $ref: '#/components/schemas/Extension'
1234
+ description: Data model for the complex type ExtensionList
1235
+ FirstName:
1236
+ title: FirstName
1237
+ maxLength: 128
1238
+ minLength: 1
1239
+ pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
1240
+ type: string
1241
+ description: First name of the Party (Name Type).
1242
+ HealthServicesType:
1243
+ title: HealthServicesType
1244
+ type: object
1245
+ properties:
1246
+ name:
1247
+ type: string
1248
+ status:
1249
+ $ref: '#/components/schemas/HealthStatusType'
1250
+ description: Data model for the complex type HealthServicesType. Contains health
1251
+ services information.
1252
+ LastName:
1253
+ title: LastName
1254
+ maxLength: 128
1255
+ minLength: 1
1256
+ pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
1257
+ type: string
1258
+ description: Last name of the Party (Name Type).
1259
+ MiddleName:
1260
+ title: MiddleName
1261
+ maxLength: 128
1262
+ minLength: 1
1263
+ pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
1264
+ type: string
1265
+ description: Middle name of the Party (Name Type).
1266
+ ParticipantsTypeIDSubIDPostRequest:
1267
+ title: ParticipantsTypeIDSubIDPostRequest
1268
+ required:
1269
+ - fspId
1270
+ type: object
1271
+ properties:
1272
+ fspId:
1273
+ $ref: '#/components/schemas/FspId'
1274
+ currency:
1275
+ $ref: '#/components/schemas/Currency'
1276
+ extensionList:
1277
+ $ref: '#/components/schemas/ExtensionList'
1278
+ description: POST /participants/{Type}/{ID}/{SubId}, /participants/{Type}/{ID}
1279
+ object
1280
+ ParticipantsTypeIDPutResponse:
1281
+ title: ParticipantsTypeIDPutResponse
1282
+ type: object
1283
+ properties:
1284
+ fspId:
1285
+ $ref: '#/components/schemas/FspId'
1286
+ description: PUT /participants/{Type}/{ID}/{SubId}, /participants/{Type}/{ID}
1287
+ object
1288
+ ParticipantsIDPutResponse:
1289
+ title: ParticipantsIDPutResponse
1290
+ required:
1291
+ - partyList
1292
+ type: object
1293
+ properties:
1294
+ partyList:
1295
+ maxItems: 10000
1296
+ minItems: 1
1297
+ type: array
1298
+ description: List of PartyResult elements that were either created or failed
1299
+ to be created.
1300
+ items:
1301
+ $ref: '#/components/schemas/PartyResult'
1302
+ currency:
1303
+ $ref: '#/components/schemas/Currency'
1304
+ description: PUT /participants/{ID} object
1305
+ ParticipantsPostRequest:
1306
+ title: ParticipantsPostRequest
1307
+ required:
1308
+ - partyList
1309
+ - requestId
1310
+ type: object
1311
+ properties:
1312
+ requestId:
1313
+ $ref: '#/components/schemas/CorrelationId'
1314
+ partyList:
1315
+ maxItems: 10000
1316
+ minItems: 1
1317
+ type: array
1318
+ description: List of PartyIdInfo elements that the client would like to
1319
+ update or create FSP information about.
1320
+ items:
1321
+ $ref: '#/components/schemas/PartyIdInfo'
1322
+ currency:
1323
+ $ref: '#/components/schemas/Currency'
1324
+ description: POST /participants object
1325
+ Party:
1326
+ title: Party
1327
+ required:
1328
+ - partyIdInfo
1329
+ type: object
1330
+ properties:
1331
+ partyIdInfo:
1332
+ $ref: '#/components/schemas/PartyIdInfo'
1333
+ merchantClassificationCode:
1334
+ $ref: '#/components/schemas/MerchantClassificationCode'
1335
+ name:
1336
+ $ref: '#/components/schemas/PartyName'
1337
+ personalInfo:
1338
+ $ref: '#/components/schemas/PartyPersonalInfo'
1339
+ description: Data model for the complex type Party.
1340
+ PartyComplexName:
1341
+ title: PartyComplexName
1342
+ type: object
1343
+ properties:
1344
+ firstName:
1345
+ $ref: '#/components/schemas/FirstName'
1346
+ middleName:
1347
+ $ref: '#/components/schemas/MiddleName'
1348
+ lastName:
1349
+ $ref: '#/components/schemas/LastName'
1350
+ description: Data model for the complex type PartyComplexName.
1351
+ PartyIdInfo:
1352
+ title: PartyIdInfo
1353
+ required:
1354
+ - partyIdType
1355
+ - partyIdentifier
1356
+ type: object
1357
+ properties:
1358
+ partyIdType:
1359
+ $ref: '#/components/schemas/PartyIdType'
1360
+ partyIdentifier:
1361
+ $ref: '#/components/schemas/PartyIdentifier'
1362
+ partySubIdOrType:
1363
+ $ref: '#/components/schemas/PartySubIdOrType'
1364
+ fspId:
1365
+ $ref: '#/components/schemas/FspId'
1366
+ extensionList:
1367
+ $ref: '#/components/schemas/ExtensionList'
1368
+ description: Data model for the complex type PartyIdInfo.
1369
+ PartyIdentifier:
1370
+ title: PartyIdentifier
1371
+ maxLength: 128
1372
+ minLength: 1
1373
+ type: string
1374
+ description: Identifier of the Party.
1375
+ PartyName:
1376
+ title: PartyName
1377
+ maxLength: 128
1378
+ minLength: 1
1379
+ type: string
1380
+ description: Name of the Party. Could be a real name or a nickname.
1381
+ PartySubIdOrType:
1382
+ title: PartySubIdOrType
1383
+ maxLength: 128
1384
+ minLength: 1
1385
+ type: string
1386
+ description: Either a sub-identifier of a PartyIdentifier, or a sub-type of
1387
+ the PartyIdType, normally a PersonalIdentifierType.
1388
+ PartiesTypeIDPutResponse:
1389
+ title: PartiesTypeIDPutResponse
1390
+ required:
1391
+ - party
1392
+ type: object
1393
+ properties:
1394
+ party:
1395
+ $ref: '#/components/schemas/Party'
1396
+ description: PUT /parties/{Type}/{ID} object
1397
+ PartyPersonalInfo:
1398
+ title: PartyPersonalInfo
1399
+ type: object
1400
+ properties:
1401
+ complexName:
1402
+ $ref: '#/components/schemas/PartyComplexName'
1403
+ dateOfBirth:
1404
+ $ref: '#/components/schemas/DateOfBirth'
1405
+ description: Data model for the complex type PartyPersonalInfo.
1406
+ PartyResult:
1407
+ title: PartyResult
1408
+ required:
1409
+ - partyId
1410
+ type: object
1411
+ properties:
1412
+ partyId:
1413
+ $ref: '#/components/schemas/PartyIdInfo'
1414
+ errorInformation:
1415
+ $ref: '#/components/schemas/ErrorInformation'
1416
+ description: Data model for the complex type PartyResult.
1417
+ Status:
1418
+ title: Status
1419
+ type: object
1420
+ properties:
1421
+ status:
1422
+ type: string
1423
+ description: The return status, usually "OK"
1424
+ uptime:
1425
+ type: number
1426
+ description: The amount of time in seconds that the server has been up for.
1427
+ startTime:
1428
+ type: string
1429
+ description: The UTC time that the server started up
1430
+ versionNumber:
1431
+ type: string
1432
+ description: Current version of the API
1433
+ services:
1434
+ type: array
1435
+ description: An list of the statuses of services that the API requires
1436
+ items:
1437
+ $ref: '#/components/schemas/HealthServicesType'
1438
+ description: Data model for the api status.
1439
+ responses:
1440
+ ErrorResponse400:
1441
+ description: Bad Request - The application cannot process the request; for example,
1442
+ due to malformed syntax or the payload exceeded size restrictions.
1443
+ headers:
1444
+ Content-Length:
1445
+ description: The Content-Length header field indicates the anticipated size
1446
+ of the payload body. Only sent if there is a body.
1447
+ schema:
1448
+ type: integer
1449
+ Content-Type:
1450
+ description: The Content-Type header indicates the specific version of the
1451
+ API used to send the payload body.
1452
+ schema:
1453
+ type: string
1454
+ content:
1455
+ application/json:
1456
+ schema:
1457
+ $ref: '#/components/schemas/ErrorInformationResponse'
1458
+ ErrorResponse401:
1459
+ description: Unauthorized - The request requires authentication in order to
1460
+ be processed.
1461
+ headers:
1462
+ Content-Length:
1463
+ description: The Content-Length header field indicates the anticipated size
1464
+ of the payload body. Only sent if there is a body.
1465
+ schema:
1466
+ type: integer
1467
+ Content-Type:
1468
+ description: The Content-Type header indicates the specific version of the
1469
+ API used to send the payload body.
1470
+ schema:
1471
+ type: string
1472
+ content:
1473
+ application/json:
1474
+ schema:
1475
+ $ref: '#/components/schemas/ErrorInformationResponse'
1476
+ ErrorResponse403:
1477
+ description: Forbidden - The request was denied and will be denied in the future.
1478
+ headers:
1479
+ Content-Length:
1480
+ description: The Content-Length header field indicates the anticipated size
1481
+ of the payload body. Only sent if there is a body.
1482
+ schema:
1483
+ type: integer
1484
+ Content-Type:
1485
+ description: The Content-Type header indicates the specific version of the
1486
+ API used to send the payload body.
1487
+ schema:
1488
+ type: string
1489
+ content:
1490
+ application/json:
1491
+ schema:
1492
+ $ref: '#/components/schemas/ErrorInformationResponse'
1493
+ ErrorResponse404:
1494
+ description: Not Found - The resource specified in the URI was not found.
1495
+ headers:
1496
+ Content-Length:
1497
+ description: The Content-Length header field indicates the anticipated size
1498
+ of the payload body. Only sent if there is a body.
1499
+ schema:
1500
+ type: integer
1501
+ Content-Type:
1502
+ description: The Content-Type header indicates the specific version of the
1503
+ API used to send the payload body.
1504
+ schema:
1505
+ type: string
1506
+ content:
1507
+ application/json:
1508
+ schema:
1509
+ $ref: '#/components/schemas/ErrorInformationResponse'
1510
+ ErrorResponse405:
1511
+ description: Method Not Allowed - An unsupported HTTP method for the request
1512
+ was used.
1513
+ headers:
1514
+ Content-Length:
1515
+ description: The Content-Length header field indicates the anticipated size
1516
+ of the payload body. Only sent if there is a body.
1517
+ schema:
1518
+ type: integer
1519
+ Content-Type:
1520
+ description: The Content-Type header indicates the specific version of the
1521
+ API used to send the payload body.
1522
+ schema:
1523
+ type: string
1524
+ content:
1525
+ application/json:
1526
+ schema:
1527
+ $ref: '#/components/schemas/ErrorInformationResponse'
1528
+ ErrorResponse406:
1529
+ description: Not acceptable - The server is not capable of generating content
1530
+ according to the Accept headers sent in the request. Used in the API to indicate
1531
+ that the server does not support the version that the client is requesting.
1532
+ headers:
1533
+ Content-Length:
1534
+ description: The Content-Length header field indicates the anticipated size
1535
+ of the payload body. Only sent if there is a body.
1536
+ schema:
1537
+ type: integer
1538
+ Content-Type:
1539
+ description: The Content-Type header indicates the specific version of the
1540
+ API used to send the payload body.
1541
+ schema:
1542
+ type: string
1543
+ content:
1544
+ application/json:
1545
+ schema:
1546
+ $ref: '#/components/schemas/ErrorInformationResponse'
1547
+ ErrorResponse501:
1548
+ description: Not Implemented - The server does not support the requested service.
1549
+ The client should not retry.
1550
+ headers:
1551
+ Content-Length:
1552
+ description: The Content-Length header field indicates the anticipated size
1553
+ of the payload body. Only sent if there is a body.
1554
+ schema:
1555
+ type: integer
1556
+ Content-Type:
1557
+ description: The Content-Type header indicates the specific version of the
1558
+ API used to send the payload body.
1559
+ schema:
1560
+ type: string
1561
+ content:
1562
+ application/json:
1563
+ schema:
1564
+ $ref: '#/components/schemas/ErrorInformationResponse'
1565
+ ErrorResponse503:
1566
+ description: Service Unavailable - The server is currently unavailable to accept
1567
+ any new service requests. This should be a temporary state, and the client
1568
+ should retry within a reasonable time frame.
1569
+ headers:
1570
+ Content-Length:
1571
+ description: The Content-Length header field indicates the anticipated size
1572
+ of the payload body. Only sent if there is a body.
1573
+ schema:
1574
+ type: integer
1575
+ Content-Type:
1576
+ description: The Content-Type header indicates the specific version of the
1577
+ API used to send the payload body.
1578
+ schema:
1579
+ type: string
1580
+ content:
1581
+ application/json:
1582
+ schema:
1583
+ $ref: '#/components/schemas/ErrorInformationResponse'
1584
+ Response200:
1585
+ description: OK
1586
+ content: {}
1587
+ Response202:
1588
+ description: Accepted
1589
+ content: {}
1590
+ ResponseHealth200:
1591
+ description: OK
1592
+ content:
1593
+ application/json:
1594
+ schema:
1595
+ $ref: '#/components/schemas/Status'
1596
+ parameters:
1597
+ Accept:
1598
+ name: accept
1599
+ in: header
1600
+ description: The Accept header field indicates the version of the API the client
1601
+ would like the server to use.
1602
+ required: true
1603
+ schema:
1604
+ type: string
1605
+ Accept-Optional:
1606
+ name: accept
1607
+ in: header
1608
+ description: The Accept header field indicates the version of the API the client
1609
+ would like the server to use.
1610
+ schema:
1611
+ type: string
1612
+ Content-Length:
1613
+ name: content-length
1614
+ in: header
1615
+ description: The Content-Length header field indicates the anticipated size
1616
+ of the payload body. Only sent if there is a body. Note - The API supports
1617
+ a maximum size of 5242880 bytes (5 Megabytes)
1618
+ schema:
1619
+ type: integer
1620
+ Content-Type:
1621
+ name: content-type
1622
+ in: header
1623
+ description: The Content-Type header indicates the specific version of the API
1624
+ used to send the payload body.
1625
+ required: true
1626
+ schema:
1627
+ type: string
1628
+ Date:
1629
+ name: date
1630
+ in: header
1631
+ description: The Date header field indicates the date when the request was sent.
1632
+ required: true
1633
+ schema:
1634
+ type: string
1635
+ X-Forwarded-For:
1636
+ name: x-forwarded-for
1637
+ in: header
1638
+ description: The X-Forwarded-For header field is an unofficially accepted standard
1639
+ used for informational purposes of the originating client IP address, as a
1640
+ request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For
1641
+ values as in the example shown here should be expected and supported by implementers
1642
+ of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239.
1643
+ However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.
1644
+ schema:
1645
+ type: string
1646
+ FSPIOP-Source:
1647
+ name: fspiop-source
1648
+ in: header
1649
+ description: The FSPIOP-Source header field is a non-HTTP standard field used
1650
+ by the API for identifying the sender of the HTTP request. The field should
1651
+ be set by the original sender of the request. Required for routing and signature
1652
+ verification (see header field FSPIOP-Signature).
1653
+ required: true
1654
+ schema:
1655
+ $ref: '#/components/schemas/FspId'
1656
+ FSPIOP-Destination-Required:
1657
+ name: fspiop-destination
1658
+ in: header
1659
+ description: The FSPIOP-Destination header field is a non-HTTP standard field
1660
+ used by the API for HTTP header based routing of requests and responses to
1661
+ the destination. The field should be set by the original sender of the request
1662
+ (if known), so that any entities between the client and the server do not
1663
+ need to parse the payload for routing purposes.
1664
+ required: true
1665
+ schema:
1666
+ $ref: '#/components/schemas/FspId'
1667
+ FSPIOP-Destination-Optional:
1668
+ name: fspiop-destination
1669
+ in: header
1670
+ description: The FSPIOP-Destination header field is a non-HTTP standard field
1671
+ used by the API for HTTP header based routing of requests and responses to
1672
+ the destination. The field should be set by the original sender of the request
1673
+ (if known), so that any entities between the client and the server do not
1674
+ need to parse the payload for routing purposes.
1675
+ schema:
1676
+ $ref: '#/components/schemas/FspId'
1677
+ FSPIOP-Encryption:
1678
+ name: fspiop-encryption
1679
+ in: header
1680
+ description: The FSPIOP-Encryption header field is a non-HTTP standard field
1681
+ used by the API for applying end-to-end encryption of the request.
1682
+ schema:
1683
+ type: string
1684
+ FSPIOP-Signature:
1685
+ name: fspiop-signature
1686
+ in: header
1687
+ description: The FSPIOP-Signature header field is a non-HTTP standard field
1688
+ used by the API for applying an end-to-end request signature.
1689
+ schema:
1690
+ type: string
1691
+ FSPIOP-URI:
1692
+ name: fspiop-uri
1693
+ in: header
1694
+ description: The FSPIOP-URI header field is a non-HTTP standard field used by
1695
+ the API for signature verification, should contain the service URI. Required
1696
+ if signature verification is used, for more information see API Signature
1697
+ document.
1698
+ schema:
1699
+ type: string
1700
+ FSPIOP-HTTP-Method:
1701
+ name: fspiop-http-method
1702
+ in: header
1703
+ description: The FSPIOP-HTTP-Method header field is a non-HTTP standard field
1704
+ used by the API for signature verification, should contain the service HTTP
1705
+ method. Required if signature verification is used, for more information see
1706
+ API Signature document.
1707
+ schema:
1708
+ type: string
1709
+ ID:
1710
+ name: ID
1711
+ in: path
1712
+ required: true
1713
+ schema:
1714
+ maxLength: 128
1715
+ minLength: 1
1716
+ type: string
1717
+ Type:
1718
+ name: Type
1719
+ in: path
1720
+ required: true
1721
+ schema:
1722
+ type: string
1723
+ enum:
1724
+ - MSISDN
1725
+ - EMAIL
1726
+ - PERSONAL_ID
1727
+ - BUSINESS
1728
+ - DEVICE
1729
+ - ACCOUNT_ID
1730
+ - IBAN
1731
+ - ALIAS
1732
+ - CONSENT
1733
+ - THIRD_PARTY_LINK
1734
+ SubId:
1735
+ name: SubId
1736
+ in: path
1737
+ required: true
1738
+ schema:
1739
+ type: string