forked from mojaloop/bulk-api-adapter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
414 lines (413 loc) · 10.9 KB
/
swagger.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
swagger: '2.0'
host: test-ml-api-adapter.mojaloop.live
basePath: /
schemes:
- http
info:
title: ml api adapter API Documentation
version: 6.2.1
tags: []
paths:
/endpointcache:
delete:
description: The HTTP request DELETE /endpointcache is used to reset the endpoint cache by performing an stopCache and initializeCache the Admin API.
summary: Endpoint Cache
tags:
- cache
operationId: EndpointCache
parameters:
- type: string
format: date
name: date
in: header
required: true
responses:
default:
schema:
type: string
description: Successful
/health:
get:
summary: Status of adapter
operationId: getHealth
tags:
- health
responses:
default:
schema:
type: string
description: Successful
/metrics:
get:
summary: Prometheus metrics endpoint
operationId: getMetrics
tags:
- metrics
responses:
default:
schema:
type: string
description: Successful
'/bulkTransfers/{id}':
get:
summary: Get a transfer by Id
operationId: getBulkTransfersId
parameters:
- type: string
pattern: 'application\/vnd.interoperability[.]'
name: accept
in: header
required: false
- type: string
pattern: 'application\/vnd.interoperability[.]'
name: content-type
in: header
required: true
- type: string
format: date
name: date
in: header
required: true
- type: string
name: x-forwarded-for
in: header
required: false
- type: string
name: fspiop-source
in: header
required: true
- type: string
name: fspiop-destination
in: header
required: false
- type: string
name: fspiop-encryption
in: header
required: false
- type: string
name: fspiop-signature
in: header
required: false
- type: string
name: fspiop-uri
in: header
required: false
- type: string
name: fspiop-http-method
in: header
required: false
- type: string
description: path
x-format:
guid: true
name: id
in: path
required: true
tags:
- bulk-transfers
responses:
default:
schema:
type: string
description: Successful
put:
summary: BulkTransfersByIDPut
operationId: BulkTransfersByIDPut
parameters:
- type: string
pattern: 'application\/vnd.interoperability[.]'
name: content-type
in: header
required: true
- type: string
format: date
name: date
in: header
required: true
- type: string
name: x-forwarded-for
in: header
required: false
- type: string
name: fspiop-source
in: header
required: true
- type: string
name: fspiop-destination
in: header
required: false
- type: string
name: fspiop-encryption
in: header
required: false
- type: string
name: fspiop-signature
in: header
required: false
- type: string
name: fspiop-uri
in: header
required: false
- type: string
name: fspiop-http-method
in: header
required: false
- type: string
description: path
name: id
in: path
required: true
- in: body
name: body
schema:
$ref: '#/definitions/BulkTransfersIDPutResponse'
tags:
- bulkTransfers
responses:
default:
schema:
type: string
description: The callback PUT /bulkTransfers/<ID> is used to inform the client of a requested or created bulk transfer. The <ID> in the URI should contain the bulkTransferId that was used for the creation of the bulk transfer (POST /bulkTransfers), or the <ID> that was used in the GET /bulkTransfers/<ID>.
/bulkTransfers:
post:
summary: Transfer API.
operationId: postBulkTransfers
parameters:
- type: string
pattern: 'application\/vnd.interoperability[.]'
name: accept
in: header
required: false
- type: string
pattern: 'application\/vnd.interoperability[.]'
name: content-type
in: header
required: true
- type: number
maximum: 5242880
name: content-length
in: header
- type: string
format: date
name: date
in: header
required: true
- type: string
name: x-forwarded-for
in: header
required: false
- type: string
name: fspiop-source
in: header
required: true
- type: string
name: fspiop-destination
in: header
required: false
- type: string
name: fspiop-encryption
in: header
required: false
- type: string
name: fspiop-signature
in: header
required: false
- type: string
name: fspiop-uri
in: header
required: false
- type: string
name: fspiop-http-method
in: header
required: false
- in: body
name: body
schema:
$ref: '#/definitions/BulkTransfersPostRequest'
tags:
- bulk-transfers
responses:
default:
schema:
type: string
description: Successful
definitions:
Amount:
type: object
description: Amount of the transfer
properties:
currency:
type: string
description: Currency of the transfer
amount:
type: string
description: Amount of the transfer
pattern: '^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$'
required:
- currency
- amount
ExtensionModel:
type: object
properties:
key:
type: string
description: Key
minLength: 1
maxLength: 32
value:
type: string
description: Value
minLength: 1
maxLength: 128
required:
- key
- value
Extension:
type: array
description: extension
minItems: 1
maxItems: 16
items:
$ref: '#/definitions/ExtensionModel'
ExtensionList:
type: object
description: Extension list
properties:
extension:
$ref: '#/definitions/Extension'
required:
- extension
IndividualTransfer:
type: object
properties:
transferId:
type: string
description: Id of transfer
x-format:
guid: true
transferAmount:
$ref: '#/definitions/Amount'
ilpPacket:
type: string
description: ilp packet
minLength: 1
maxLength: 32768
pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
condition:
type: string
description: Condition of transfer
maxLength: 48
pattern: '^[A-Za-z0-9-_]{43}$'
x-convert:
trim: true
extensionList:
$ref: '#/definitions/ExtensionList'
required:
- transferId
- transferAmount
- ilpPacket
- condition
IndividualTransferResult:
title: IndividualTransferResult
type: object
description: Data model for the complex type IndividualTransferResult.
properties:
transferId:
type: string
description: Identifies messages related to the same /transfers sequence.
fulfilment:
type: string
description: Fulfilment of the condition specified with the transaction. Note - Either fulfilment or errorInformation should be set, not both.
errorInformation:
$ref: '#/definitions/ErrorInformation'
description: If transfer is REJECTED, error information may be provided. Note - Either fulfilment or errorInformation should be set, not both.
extensionList:
$ref: '#/definitions/ExtensionList'
description: Optional extension, specific to deployment.
required:
- transferId
ErrorInformation:
type: object
description: Error information
properties:
errorDescription:
type: string
errorCode:
type: string
pattern: '^[0-9]{4}'
extensionList:
$ref: '#/definitions/ExtensionList'
required:
- errorDescription
- errorCode
Error:
type: object
properties:
errorInformation:
$ref: '#/definitions/ErrorInformation'
required:
- errorInformation
BulkTransfersPostRequest:
type: object
properties:
bulkTransferId:
type: string
description: Id of bulk transfers
x-format:
guid: true
bulkQuoteId:
type: string
description: Id of bulk quote
x-format:
guid: true
payeeFsp:
type: string
description: Financial Service Provider of Payee
minLength: 1
maxLength: 32
payerFsp:
type: string
description: Financial Service Provider of Payer
minLength: 1
maxLength: 32
extensionList:
$ref: '#/definitions/ExtensionList'
expiration:
type: string
description: When the transfer expires
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)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
individualTransfers:
type: array
description: individual transfers list
minItems: 1
items:
$ref: '#/definitions/IndividualTransfer'
required:
- bulkTransferId
- bulkQuoteId
- payerFsp
- payeeFsp
- individualTransfers
- expiration
BulkTransfersIDPutResponse:
type: object
properties:
completedTimestamp:
type: string
description: Time and date when the bulk transaction was completed.
individualTransferResults:
type: array
minItems: 1
maxItems: 1000
items:
$ref: '#/definitions/IndividualTransferResult'
description: List of IndividualTransferResult elements.
bulkTransferState:
type: string
description: The state of the bulk transfer.
extensionList:
$ref: '#/definitions/ExtensionList'
description: Optional extension, specific to deployment.
required:
- bulkTransferState