@mojaloop/ml-testing-toolkit-shared-lib 12.2.0 → 13.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,2157 +0,0 @@
1
- openapi: 3.0.0
2
- info:
3
- version: '1.0'
4
- title: Open API for FSP Interoperability (FSPIOP)
5
- description: >-
6
- Based on API Definition.docx updated on 2018-03-13 Version 1.0. Note - The
7
- API supports a maximum size of 65536 bytes (64 Kilobytes) in the HTTP
8
- header.
9
- license:
10
- name: Open API for FSP Interoperability (FSPIOP)
11
- paths:
12
- /quotes:
13
- post:
14
- description: >-
15
- The HTTP request POST /quotes is used to request the creation of a quote
16
- for the provided financial transaction in the server.
17
- summary: Quotes
18
- tags:
19
- - quotes
20
- parameters:
21
- - $ref: '#/components/parameters/Accept'
22
- - $ref: '#/components/parameters/Content-Length'
23
- - $ref: '#/components/parameters/Content-Type'
24
- - $ref: '#/components/parameters/Date'
25
- - $ref: '#/components/parameters/X-Forwarded-For'
26
- - $ref: '#/components/parameters/FSPIOP-Source'
27
- - $ref: '#/components/parameters/FSPIOP-Destination'
28
- - $ref: '#/components/parameters/FSPIOP-Encryption'
29
- - $ref: '#/components/parameters/FSPIOP-Signature'
30
- - $ref: '#/components/parameters/FSPIOP-URI'
31
- - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
32
- x-examples:
33
- application/json:
34
- quoteId: b51ec534-ee48-4575-b6a9-ead2955b8069
35
- transactionId: a8323bc6-c228-4df2-ae82-e5a997baf899
36
- transactionRequestId: a8323bc6-c228-4df2-ae82-e5a997baf890
37
- payee:
38
- partyIdInfo:
39
- partyIdType: PERSONAL_ID
40
- partyIdentifier: '16135551212'
41
- partySubIdOrType: DRIVING_LICENSE
42
- fspId: '1234'
43
- merchantClassificationCode: '4321'
44
- name: Justin Trudeau
45
- personalInfo:
46
- complexName:
47
- firstName: Justin
48
- middleName: Pierre
49
- lastName: Trudeau
50
- dateOfBirth: '1971-12-25'
51
- payer:
52
- partyIdInfo:
53
- partyIdType: PERSONAL_ID
54
- partyIdentifier: '16135551212'
55
- partySubIdOrType: PASSPORT
56
- fspId: '1234'
57
- merchantClassificationCode: '1234'
58
- name: Donald Trump
59
- personalInfo:
60
- complexName:
61
- firstName: Donald
62
- middleName: John
63
- lastName: Trump
64
- dateOfBirth: '1946-06-14'
65
- amountType: SEND
66
- amount:
67
- currency: USD
68
- amount: '123.45'
69
- fees:
70
- currency: USD
71
- amount: '1.25'
72
- transactionType:
73
- scenario: DEPOSIT
74
- subScenario: locally defined sub-scenario
75
- initiator: PAYEE
76
- initiatorType: CONSUMER
77
- refundInfo:
78
- originalTransactionId: b51ec534-ee48-4575-b6a9-ead2955b8069
79
- refundReason: free text indicating reason for the refund
80
- balanceOfPayments: '123'
81
- geoCode:
82
- latitude: '+45.4215'
83
- longitude: '+75.6972'
84
- note: Free-text memo
85
- expiration: '2016-05-24T08:38:08.699-04:00'
86
- extensionList:
87
- extension:
88
- - key: errorDescription
89
- value: This is a more detailed error description
90
- - key: errorDescription
91
- value: This is a more detailed error description
92
- responses:
93
- '400':
94
- $ref: '#/components/responses/ErrorResponse400'
95
- '202':
96
- $ref: '#/components/responses/Response202'
97
- '401':
98
- $ref: '#/components/responses/ErrorResponse401'
99
- '403':
100
- $ref: '#/components/responses/ErrorResponse403'
101
- '404':
102
- $ref: '#/components/responses/ErrorResponse404'
103
- '405':
104
- $ref: '#/components/responses/ErrorResponse405'
105
- '406':
106
- $ref: '#/components/responses/ErrorResponse406'
107
- '501':
108
- $ref: '#/components/responses/ErrorResponse501'
109
- '503':
110
- $ref: '#/components/responses/ErrorResponse503'
111
- requestBody:
112
- content:
113
- application/json:
114
- schema:
115
- $ref: '#/components/schemas/QuotesPostRequest'
116
- required: true
117
- '/authorizations/{ID}':
118
- parameters:
119
- - $ref: '#/components/parameters/ID'
120
- - $ref: '#/components/parameters/Content-Type'
121
- - $ref: '#/components/parameters/Date'
122
- - $ref: '#/components/parameters/X-Forwarded-For'
123
- - $ref: '#/components/parameters/FSPIOP-Source'
124
- - $ref: '#/components/parameters/FSPIOP-Destination'
125
- - $ref: '#/components/parameters/FSPIOP-Encryption'
126
- - $ref: '#/components/parameters/FSPIOP-Signature'
127
- - $ref: '#/components/parameters/FSPIOP-URI'
128
- - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
129
- get:
130
- description: >-
131
- The HTTP request GET /authorizations/ is used to request the Payer to
132
- enter the applicable credentials in the Payee FSP system. The in the
133
- URI should contain the transactionRequestID, received from the POST
134
- /transactionRequests service earlier in the process. This request
135
- requires a query string to be included in the URI, with the following
136
- key-value pairs - authenticationType=, where value is a valid
137
- authentication type from the enumeration AuthenticationType.
138
- retriesLeft==, where is the number of retries left before the financial
139
- transaction is rejected. must be expressed in the form of the data type
140
- Integer. retriesLeft=1 means that this is the last retry before the
141
- financial transaction is rejected. amount=, where is the transaction
142
- amount that will be withdrawn from the Payer’s account. must be
143
- expressed in the form of the data type Amount. currency=, where is the
144
- transaction currency for the amount that will be withdrawn from the
145
- Payer’s account. The value must be expressed in the form of the
146
- enumeration CurrencyCode. An example URI containing all the required
147
- key-value pairs in the query string is the following - GET
148
- /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD
149
- summary: AuthorizationsByID
150
- tags:
151
- - authorizations
152
- operationId: AuthorizationsByIDGet
153
- parameters:
154
- - $ref: '#/components/parameters/Accept'
155
- responses:
156
- '400':
157
- $ref: '#/components/responses/ErrorResponse400'
158
- '202':
159
- $ref: '#/components/responses/Response202'
160
- '401':
161
- $ref: '#/components/responses/ErrorResponse401'
162
- '403':
163
- $ref: '#/components/responses/ErrorResponse403'
164
- '404':
165
- $ref: '#/components/responses/ErrorResponse404'
166
- '405':
167
- $ref: '#/components/responses/ErrorResponse405'
168
- '406':
169
- $ref: '#/components/responses/ErrorResponse406'
170
- '501':
171
- $ref: '#/components/responses/ErrorResponse501'
172
- '503':
173
- $ref: '#/components/responses/ErrorResponse503'
174
- put:
175
- description: >-
176
- The callback PUT /authorizations/ is used to inform the client of the
177
- result of a previously-requested authorization. The in the URI should
178
- contain the that was used in the GET /authorizations/.
179
- summary: AuthorizationsByID
180
- tags:
181
- - authorizations
182
- operationId: AuthorizationsByIDPut
183
- parameters:
184
- - $ref: '#/components/parameters/Content-Length'
185
- x-examples:
186
- application/json:
187
- authenticationInfo:
188
- authentication: OTP
189
- authenticationValue: '1234'
190
- responseType: ENTERED
191
- responses:
192
- '200':
193
- $ref: '#/components/responses/Response200'
194
- '400':
195
- $ref: '#/components/responses/ErrorResponse400'
196
- '401':
197
- $ref: '#/components/responses/ErrorResponse401'
198
- '403':
199
- $ref: '#/components/responses/ErrorResponse403'
200
- '404':
201
- $ref: '#/components/responses/ErrorResponse404'
202
- '405':
203
- $ref: '#/components/responses/ErrorResponse405'
204
- '406':
205
- $ref: '#/components/responses/ErrorResponse406'
206
- '501':
207
- $ref: '#/components/responses/ErrorResponse501'
208
- '503':
209
- $ref: '#/components/responses/ErrorResponse503'
210
- requestBody:
211
- content:
212
- application/json:
213
- schema:
214
- $ref: '#/components/schemas/AuthorizationsIDPutResponse'
215
- required: true
216
- '/authorizations/{ID}/error':
217
- put:
218
- description: >-
219
- If the server is unable to find the transaction request, or another
220
- processing error occurs, the error callback PUT /authorizations//error
221
- is used. The in the URI should contain the that was used in the GET
222
- /authorizations/.
223
- summary: AuthorizationsByIDAndError
224
- tags:
225
- - authorizations
226
- operationId: AuthorizationsByIDAndError
227
- parameters:
228
- - $ref: '#/components/parameters/ID'
229
- - $ref: '#/components/parameters/Content-Length'
230
- - $ref: '#/components/parameters/Content-Type'
231
- - $ref: '#/components/parameters/Date'
232
- - $ref: '#/components/parameters/X-Forwarded-For'
233
- - $ref: '#/components/parameters/FSPIOP-Source'
234
- - $ref: '#/components/parameters/FSPIOP-Destination'
235
- - $ref: '#/components/parameters/FSPIOP-Encryption'
236
- - $ref: '#/components/parameters/FSPIOP-Signature'
237
- - $ref: '#/components/parameters/FSPIOP-URI'
238
- - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
239
- x-examples:
240
- application/json:
241
- errorInformation:
242
- errorCode: '5100'
243
- errorDescription: This is an error description
244
- extensionList:
245
- extension:
246
- - key: errorDescription
247
- value: This is a more detailed error description
248
- - key: errorDescription
249
- value: This is a more detailed error description
250
- responses:
251
- '200':
252
- $ref: '#/components/responses/Response200'
253
- '400':
254
- $ref: '#/components/responses/ErrorResponse400'
255
- '401':
256
- $ref: '#/components/responses/ErrorResponse401'
257
- '403':
258
- $ref: '#/components/responses/ErrorResponse403'
259
- '404':
260
- $ref: '#/components/responses/ErrorResponse404'
261
- '405':
262
- $ref: '#/components/responses/ErrorResponse405'
263
- '406':
264
- $ref: '#/components/responses/ErrorResponse406'
265
- '501':
266
- $ref: '#/components/responses/ErrorResponse501'
267
- '503':
268
- $ref: '#/components/responses/ErrorResponse503'
269
- requestBody:
270
- $ref: '#/components/requestBodies/ErrorInformationObject'
271
- '/transfers/{ID}':
272
- parameters:
273
- - $ref: '#/components/parameters/ID'
274
- - $ref: '#/components/parameters/Content-Type'
275
- - $ref: '#/components/parameters/Date'
276
- - $ref: '#/components/parameters/X-Forwarded-For'
277
- - $ref: '#/components/parameters/FSPIOP-Source'
278
- - $ref: '#/components/parameters/FSPIOP-Destination'
279
- - $ref: '#/components/parameters/FSPIOP-Encryption'
280
- - $ref: '#/components/parameters/FSPIOP-Signature'
281
- - $ref: '#/components/parameters/FSPIOP-URI'
282
- - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
283
- get:
284
- description: >-
285
- The HTTP request GET /transfers/ is used to get information regarding an
286
- earlier created or requested transfer. The in the URI should contain
287
- the transferId that was used for the creation of the transfer.
288
- summary: TransfersByIDGet
289
- tags:
290
- - transfers
291
- operationId: TransfersByIDGet
292
- parameters:
293
- - $ref: '#/components/parameters/Accept'
294
- responses:
295
- '202':
296
- $ref: '#/components/responses/Response202'
297
- '400':
298
- $ref: '#/components/responses/ErrorResponse400'
299
- '401':
300
- $ref: '#/components/responses/ErrorResponse401'
301
- '403':
302
- $ref: '#/components/responses/ErrorResponse403'
303
- '404':
304
- $ref: '#/components/responses/ErrorResponse404'
305
- '405':
306
- $ref: '#/components/responses/ErrorResponse405'
307
- '406':
308
- $ref: '#/components/responses/ErrorResponse406'
309
- '501':
310
- $ref: '#/components/responses/ErrorResponse501'
311
- '503':
312
- $ref: '#/components/responses/ErrorResponse503'
313
- put:
314
- description: >-
315
- The callback PUT /transfers/ is used to inform the client of a requested
316
- or created transfer. The in the URI should contain the transferId that
317
- was used for the creation of the transfer, or the that was used in the
318
- GET /transfers/.
319
- summary: TransfersByIDPut
320
- tags:
321
- - transfers
322
- operationId: TransfersByIDPut
323
- parameters:
324
- - $ref: '#/components/parameters/Content-Length'
325
- x-examples:
326
- application/json:
327
- fulfilment: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
328
- completedTimestamp: '2016-05-24T08:38:08.699-04:00'
329
- transferState: RESERVED
330
- extensionList:
331
- extension:
332
- - key: errorDescription
333
- value: This is a more detailed error description
334
- - key: errorDescription
335
- value: This is a more detailed error description
336
- responses:
337
- '200':
338
- $ref: '#/components/responses/Response200'
339
- '400':
340
- $ref: '#/components/responses/ErrorResponse400'
341
- '401':
342
- $ref: '#/components/responses/ErrorResponse401'
343
- '403':
344
- $ref: '#/components/responses/ErrorResponse403'
345
- '404':
346
- $ref: '#/components/responses/ErrorResponse404'
347
- '405':
348
- $ref: '#/components/responses/ErrorResponse405'
349
- '406':
350
- $ref: '#/components/responses/ErrorResponse406'
351
- '501':
352
- $ref: '#/components/responses/ErrorResponse501'
353
- '503':
354
- $ref: '#/components/responses/ErrorResponse503'
355
- requestBody:
356
- content:
357
- application/json:
358
- schema:
359
- $ref: '#/components/schemas/TransfersIDPutResponse'
360
- required: true
361
- '/transfers/{ID}/error':
362
- put:
363
- description: >-
364
- If the server is unable to find or create a transfer, or another
365
- processing error occurs, the error callback PUT /transfers//error is
366
- used. The in the URI should contain the transferId that was used for
367
- the creation of the transfer, or the that was used in the GET
368
- /transfers/.
369
- summary: TransfersByIDAndError
370
- tags:
371
- - transfers
372
- operationId: TransfersByIDAndError
373
- parameters:
374
- - $ref: '#/components/parameters/ID'
375
- - $ref: '#/components/parameters/Content-Length'
376
- - $ref: '#/components/parameters/Content-Type'
377
- - $ref: '#/components/parameters/Date'
378
- - $ref: '#/components/parameters/X-Forwarded-For'
379
- - $ref: '#/components/parameters/FSPIOP-Source'
380
- - $ref: '#/components/parameters/FSPIOP-Destination'
381
- - $ref: '#/components/parameters/FSPIOP-Encryption'
382
- - $ref: '#/components/parameters/FSPIOP-Signature'
383
- - $ref: '#/components/parameters/FSPIOP-URI'
384
- - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
385
- x-examples:
386
- application/json:
387
- errorInformation:
388
- errorCode: '5100'
389
- errorDescription: This is an error description
390
- extensionList:
391
- extension:
392
- - key: errorDescription
393
- value: This is a more detailed error description
394
- - key: errorDescription
395
- value: This is a more detailed error description
396
- responses:
397
- '200':
398
- $ref: '#/components/responses/Response200'
399
- '400':
400
- $ref: '#/components/responses/ErrorResponse400'
401
- '401':
402
- $ref: '#/components/responses/ErrorResponse401'
403
- '403':
404
- $ref: '#/components/responses/ErrorResponse403'
405
- '404':
406
- $ref: '#/components/responses/ErrorResponse404'
407
- '405':
408
- $ref: '#/components/responses/ErrorResponse405'
409
- '406':
410
- $ref: '#/components/responses/ErrorResponse406'
411
- '501':
412
- $ref: '#/components/responses/ErrorResponse501'
413
- '503':
414
- $ref: '#/components/responses/ErrorResponse503'
415
- requestBody:
416
- $ref: '#/components/requestBodies/ErrorInformationObject'
417
- /transfers:
418
- post:
419
- description: >-
420
- The HTTP request POST /transfers is used to request the creation of a
421
- transfer for the next ledger, and a financial transaction for the Payee
422
- FSP.
423
- summary: Transfers
424
- tags:
425
- - transfers
426
- operationId: transfers
427
- x-examples:
428
- application/json:
429
- transferId: b51ec534-ee48-4575-b6a9-ead2955b8069
430
- payeeFsp: '1234'
431
- payerFsp: '5678'
432
- amount:
433
- currency: USD
434
- amount: '123.45'
435
- ilpPacket: >-
436
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
437
- condition: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
438
- expiration: '2016-05-24T08:38:08.699-04:00'
439
- extensionList:
440
- extension:
441
- - key: errorDescription
442
- value: This is a more detailed error description
443
- - key: errorDescription
444
- value: This is a more detailed error description
445
- responses:
446
- '202':
447
- $ref: '#/components/responses/Response202'
448
- '400':
449
- $ref: '#/components/responses/ErrorResponse400'
450
- '401':
451
- $ref: '#/components/responses/ErrorResponse401'
452
- '403':
453
- $ref: '#/components/responses/ErrorResponse403'
454
- '404':
455
- $ref: '#/components/responses/ErrorResponse404'
456
- '405':
457
- $ref: '#/components/responses/ErrorResponse405'
458
- '406':
459
- $ref: '#/components/responses/ErrorResponse406'
460
- '501':
461
- $ref: '#/components/responses/ErrorResponse501'
462
- '503':
463
- $ref: '#/components/responses/ErrorResponse503'
464
- requestBody:
465
- content:
466
- application/json:
467
- schema:
468
- $ref: '#/components/schemas/TransfersPostRequest'
469
- required: true
470
- '/requests/{ID}':
471
- get:
472
- description: Test support method. Allows the caller to see the body of a previous request
473
- summary: getRequestsById
474
- tags:
475
- - test
476
- operationId: getRequestsById
477
- parameters:
478
- - $ref: '#/components/parameters/ID'
479
- responses:
480
- '200':
481
- description: Response
482
- content:
483
- application/json:
484
- schema:
485
- type: object
486
- '/callbacks/{ID}':
487
- get:
488
- description: Test support method. Allows the caller to see the body of a previous callback
489
- summary: getRequestsById
490
- tags:
491
- - test
492
- operationId: getCallbackById
493
- parameters:
494
- - $ref: '#/components/parameters/ID'
495
- responses:
496
- '200':
497
- description: Response
498
- content:
499
- application/json:
500
- schema:
501
- type: object
502
- components:
503
- parameters:
504
- Accept:
505
- name: Accept
506
- in: header
507
- required: true
508
- description: >-
509
- The Accept header field indicates the version of the API the client
510
- would like the server to use.
511
- schema:
512
- type: string
513
- Content-Length:
514
- name: Content-Length
515
- in: header
516
- required: false
517
- description: >-
518
- The Content-Length header field indicates the anticipated size of the
519
- payload body. Only sent if there is a body. Note - The API supports a
520
- maximum size of 5242880 bytes (5 Megabytes)
521
- schema:
522
- type: integer
523
- Content-Type:
524
- name: Content-Type
525
- in: header
526
- required: true
527
- description: >-
528
- The Content-Type header indicates the specific version of the API used
529
- to send the payload body.
530
- schema:
531
- type: string
532
- Date:
533
- name: Date
534
- in: header
535
- required: true
536
- description: The Date header field indicates the date when the request was sent.
537
- schema:
538
- type: string
539
- X-Forwarded-For:
540
- name: X-Forwarded-For
541
- in: header
542
- required: false
543
- description: >-
544
- The X-Forwarded-For header field is an unofficially accepted standard
545
- used for informational purposes of the originating client IP address, as
546
- a request might pass multiple proxies, firewalls, and so on. Multiple
547
- X-Forwarded-For values as in the example shown here should be expected
548
- and supported by implementers of the API. Note - An alternative to
549
- X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239
550
- is less-used and supported than X-Forwarded-For.
551
- schema:
552
- type: string
553
- FSPIOP-Source:
554
- name: FSPIOP-Source
555
- in: header
556
- required: true
557
- description: >-
558
- The FSPIOP-Source header field is a non-HTTP standard field used by the
559
- API for identifying the sender of the HTTP request. The field should be
560
- set by the original sender of the request. Required for routing and
561
- signature verification (see header field FSPIOP-Signature).
562
- schema:
563
- type: string
564
- FSPIOP-Destination:
565
- name: FSPIOP-Destination
566
- in: header
567
- required: false
568
- description: >-
569
- The FSPIOP-Destination header field is a non-HTTP standard field used by
570
- the API for HTTP header based routing of requests and responses to the
571
- destination. The field should be set by the original sender of the
572
- request (if known), so that any entities between the client and the
573
- server do not need to parse the payload for routing purposes.
574
- schema:
575
- type: string
576
- FSPIOP-Encryption:
577
- name: FSPIOP-Encryption
578
- in: header
579
- required: false
580
- description: >-
581
- The FSPIOP-Encryption header field is a non-HTTP standard field used by
582
- the API for applying end-to-end encryption of the request.
583
- schema:
584
- type: string
585
- FSPIOP-Signature:
586
- name: FSPIOP-Signature
587
- in: header
588
- required: false
589
- description: >-
590
- The FSPIOP-Signature header field is a non-HTTP standard field used by
591
- the API for applying an end-to-end request signature.
592
- FSPIOP-URI:
593
- name: FSPIOP-URI
594
- required: false
595
- description: >-
596
- The FSPIOP-URI header field is a non-HTTP standard field used by the API
597
- for signature verification, should contain the service URI. Required if
598
- signature verification is used, for more information see API Signature
599
- document.
600
- schema:
601
- type: string
602
- FSPIOP-HTTP-Method:
603
- name: FSPIOP-HTTP-Method
604
- in: header
605
- required: false
606
- description: >-
607
- The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by
608
- the API for signature verification, should contain the service HTTP
609
- method. Required if signature verification is used, for more information
610
- see API Signature document.
611
- schema:
612
- type: string
613
- ID:
614
- name: ID
615
- in: path
616
- required: true
617
- schema:
618
- type: string
619
- Type:
620
- name: Type
621
- in: path
622
- required: true
623
- schema:
624
- $ref: '#/components/schemas/PartyIdType'
625
- SubId:
626
- name: SubId
627
- in: path
628
- required: true
629
- schema:
630
- type: string
631
- responses:
632
- Response200:
633
- description: OK
634
- Response202:
635
- description: Accepted
636
- ErrorResponse400:
637
- description: >-
638
- Bad Request - The application cannot process the request; for example,
639
- due to malformed syntax or the payload exceeded size restrictions.
640
- headers:
641
- Content-Length:
642
- description: >-
643
- The Content-Length header field indicates the anticipated size of
644
- the payload body. Only sent if there is a body.
645
- schema:
646
- type: integer
647
- Content-Type:
648
- description: >-
649
- The Content-Type header indicates the specific version of the API
650
- used to send the payload body.
651
- schema:
652
- type: string
653
- content:
654
- application/json:
655
- schema:
656
- $ref: '#/components/schemas/ErrorInformationResponse'
657
- ErrorResponse401:
658
- description: >-
659
- Unauthorized - The request requires authentication in order to be
660
- processed.
661
- headers:
662
- Content-Length:
663
- description: >-
664
- The Content-Length header field indicates the anticipated size of
665
- the payload body. Only sent if there is a body.
666
- schema:
667
- type: integer
668
- Content-Type:
669
- description: >-
670
- The Content-Type header indicates the specific version of the API
671
- used to send the payload body.
672
- schema:
673
- type: string
674
- content:
675
- application/json:
676
- schema:
677
- $ref: '#/components/schemas/ErrorInformationResponse'
678
- ErrorResponse403:
679
- description: Forbidden - The request was denied and will be denied in the future.
680
- headers:
681
- Content-Length:
682
- description: >-
683
- The Content-Length header field indicates the anticipated size of
684
- the payload body. Only sent if there is a body.
685
- schema:
686
- type: integer
687
- Content-Type:
688
- description: >-
689
- The Content-Type header indicates the specific version of the API
690
- used to send the payload body.
691
- schema:
692
- type: string
693
- content:
694
- application/json:
695
- schema:
696
- $ref: '#/components/schemas/ErrorInformationResponse'
697
- ErrorResponse404:
698
- description: Not Found - The resource specified in the URI was not found.
699
- headers:
700
- Content-Length:
701
- description: >-
702
- The Content-Length header field indicates the anticipated size of
703
- the payload body. Only sent if there is a body.
704
- schema:
705
- type: integer
706
- Content-Type:
707
- description: >-
708
- The Content-Type header indicates the specific version of the API
709
- used to send the payload body.
710
- schema:
711
- type: string
712
- content:
713
- application/json:
714
- schema:
715
- $ref: '#/components/schemas/ErrorInformationResponse'
716
- ErrorResponse405:
717
- description: >-
718
- Method Not Allowed - An unsupported HTTP method for the request was
719
- used.
720
- headers:
721
- Content-Length:
722
- description: >-
723
- The Content-Length header field indicates the anticipated size of
724
- the payload body. Only sent if there is a body.
725
- schema:
726
- type: integer
727
- Content-Type:
728
- description: >-
729
- The Content-Type header indicates the specific version of the API
730
- used to send the payload body.
731
- schema:
732
- type: string
733
- content:
734
- application/json:
735
- schema:
736
- $ref: '#/components/schemas/ErrorInformationResponse'
737
- ErrorResponse406:
738
- description: >-
739
- Not acceptable - The server is not capable of generating content
740
- according to the Accept headers sent in the request. Used in the API to
741
- indicate that the server does not support the version that the client is
742
- requesting.
743
- headers:
744
- Content-Length:
745
- description: >-
746
- The Content-Length header field indicates the anticipated size of
747
- the payload body. Only sent if there is a body.
748
- schema:
749
- type: integer
750
- Content-Type:
751
- description: >-
752
- The Content-Type header indicates the specific version of the API
753
- used to send the payload body.
754
- schema:
755
- type: string
756
- content:
757
- application/json:
758
- schema:
759
- $ref: '#/components/schemas/ErrorInformationResponse'
760
- ErrorResponse501:
761
- description: >-
762
- Not Implemented - The server does not support the requested service. The
763
- client should not retry.
764
- headers:
765
- Content-Length:
766
- description: >-
767
- The Content-Length header field indicates the anticipated size of
768
- the payload body. Only sent if there is a body.
769
- schema:
770
- type: integer
771
- Content-Type:
772
- description: >-
773
- The Content-Type header indicates the specific version of the API
774
- used to send the payload body.
775
- schema:
776
- type: string
777
- content:
778
- application/json:
779
- schema:
780
- $ref: '#/components/schemas/ErrorInformationResponse'
781
- ErrorResponse503:
782
- description: >-
783
- Service Unavailable - The server is currently unavailable to accept any
784
- new service requests. This should be a temporary state, and the client
785
- should retry within a reasonable time frame.
786
- headers:
787
- Content-Length:
788
- description: >-
789
- The Content-Length header field indicates the anticipated size of
790
- the payload body. Only sent if there is a body.
791
- schema:
792
- type: integer
793
- Content-Type:
794
- description: >-
795
- The Content-Type header indicates the specific version of the API
796
- used to send the payload body.
797
- schema:
798
- type: string
799
- content:
800
- application/json:
801
- schema:
802
- $ref: '#/components/schemas/ErrorInformationResponse'
803
- requestBodies:
804
- ParticipantsTypeIDSubIDPostRequest:
805
- content:
806
- application/json:
807
- schema:
808
- $ref: '#/components/schemas/ParticipantsTypeIDSubIDPostRequest'
809
- required: true
810
- ErrorInformationObject:
811
- content:
812
- application/json:
813
- schema:
814
- $ref: '#/components/schemas/ErrorInformationObject'
815
- required: true
816
- ParticipantsTypeIDPutResponse:
817
- content:
818
- application/json:
819
- schema:
820
- $ref: '#/components/schemas/ParticipantsTypeIDPutResponse'
821
- required: true
822
- PartiesTypeIDPutResponse:
823
- content:
824
- application/json:
825
- schema:
826
- $ref: '#/components/schemas/PartiesTypeIDPutResponse'
827
- required: true
828
- schemas:
829
- Amount:
830
- title: Amount
831
- type: string
832
- pattern: '^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$'
833
- description: >-
834
- The API data type Amount is a JSON String in a canonical format that is
835
- restricted by a regular expression for interoperability reasons. This
836
- pattern does not allow any trailing zeroes at all, but allows an amount
837
- without a minor currency unit. It also only allows four digits in the
838
- minor currency unit; a negative value is not allowed. Using more than 18
839
- digits in the major currency unit is not allowed.
840
- AmountType:
841
- title: AmountType
842
- type: string
843
- enum:
844
- - SEND
845
- - RECEIVE
846
- description: >-
847
- Below are the allowed values for the enumeration AmountType - SEND
848
- Amount the Payer would like to send, that is, the amount that should be
849
- withdrawn from the Payer account including any fees. - RECEIVE Amount
850
- the Payer would like the Payee to receive, that is, the amount that
851
- should be sent to the receiver exclusive fees.
852
- AuthenticationType:
853
- title: AuthenticationTypeEnum
854
- type: string
855
- enum:
856
- - OTP
857
- - QRCODE
858
- description: >-
859
- Below are the allowed values for the enumeration AuthenticationType. -
860
- OTP One-time password generated by the Payer FSP. - QRCODE QR code used
861
- as One Time Password.
862
- AuthenticationValue:
863
- title: AuthenticationValue
864
- type: string
865
- pattern: '^\d{3,10}$|^\S{1,64}$'
866
- description: >-
867
- Contains the authentication value. The format depends on the
868
- authentication type used in the AuthenticationInfo complex type.
869
- AuthorizationResponse:
870
- title: AuthorizationResponse
871
- type: string
872
- enum:
873
- - ENTERED
874
- - REJECTED
875
- - RESEND
876
- description: >-
877
- Below are the allowed values for the enumeration - ENTERED Consumer
878
- entered the authentication value. - REJECTED Consumer rejected the
879
- transaction. - RESEND Consumer requested to resend the authentication
880
- value.
881
- BalanceOfPayments:
882
- title: BalanceOfPayments
883
- type: string
884
- pattern: '^[1-9]\d{2}$'
885
- description: >-
886
- (BopCode) The API data type BopCode is a JSON String of 3 characters,
887
- consisting of digits only. Negative numbers are not allowed. A leading
888
- zero is not allowed. https://www.imf.org/external/np/sta/bopcode/
889
- BinaryString:
890
- type: string
891
- pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
892
- description: >-
893
- The API data type BinaryString is a JSON String. The string is a
894
- base64url encoding of a string of raw bytes, where padding (character
895
- ‘=’) is added at the end of the data if needed to ensure that the string
896
- is a multiple of 4 characters. The length restriction indicates the
897
- allowed number of characters.
898
- BinaryString32:
899
- type: string
900
- pattern: '^[A-Za-z0-9-_]{43}$'
901
- description: >-
902
- The API data type BinaryString32 is a fixed size version of the API data
903
- type BinaryString, where the raw underlying data is always of 32 bytes.
904
- The data type BinaryString32 should not use a padding character as the
905
- size of the underlying data is fixed.
906
- BulkTransferState:
907
- title: BulkTransactionStateEnum
908
- type: string
909
- enum:
910
- - RECEIVED
911
- - PENDING
912
- - ACCEPTED
913
- - PROCESSING
914
- - COMPLETED
915
- - REJECTED
916
- description: >-
917
- Below are the allowed values for the enumeration - RECEIVED Payee FSP
918
- has received the bulk transfer from the Payer FSP. - PENDING Payee FSP
919
- has validated the bulk transfer. - ACCEPTED Payee FSP has accepted to
920
- process the bulk transfer. - PROCESSING Payee FSP has started to
921
- transfer fund to the Payees. - COMPLETED Payee FSP has completed
922
- transfer of funds to the Payees. - REJECTED Payee FSP has rejected to
923
- process the bulk transfer.
924
- Code:
925
- title: Code
926
- type: string
927
- pattern: '^[0-9a-zA-Z]{4,32}$'
928
- description: Any code/token returned by the Payee FSP (TokenCode Type).
929
- CorrelationId:
930
- title: CorrelationId
931
- type: string
932
- pattern: >-
933
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
934
- description: >-
935
- Identifier that correlates all messages of the same sequence. The API
936
- data type UUID (Universally Unique Identifier) is a JSON String in
937
- canonical format, conforming to RFC 4122, that is restricted by a
938
- regular expression for interoperability reasons. An UUID is always 36
939
- characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
940
- Currency:
941
- title: CurrencyEnum
942
- description: >-
943
- The currency codes defined in ISO 4217 as three-letter alphabetic codes
944
- are used as the standard naming representation for currencies.
945
- type: string
946
- minLength: 3
947
- maxLength: 3
948
- enum:
949
- - AED
950
- - AFN
951
- - ALL
952
- - AMD
953
- - ANG
954
- - AOA
955
- - ARS
956
- - AUD
957
- - AWG
958
- - AZN
959
- - BAM
960
- - BBD
961
- - BDT
962
- - BGN
963
- - BHD
964
- - BIF
965
- - BMD
966
- - BND
967
- - BOB
968
- - BRL
969
- - BSD
970
- - BTN
971
- - BWP
972
- - BYN
973
- - BZD
974
- - CAD
975
- - CDF
976
- - CHF
977
- - CLP
978
- - CNY
979
- - COP
980
- - CRC
981
- - CUC
982
- - CUP
983
- - CVE
984
- - CZK
985
- - DJF
986
- - DKK
987
- - DOP
988
- - DZD
989
- - EGP
990
- - ERN
991
- - ETB
992
- - EUR
993
- - FJD
994
- - FKP
995
- - GBP
996
- - GEL
997
- - GGP
998
- - GHS
999
- - GIP
1000
- - GMD
1001
- - GNF
1002
- - GTQ
1003
- - GYD
1004
- - HKD
1005
- - HNL
1006
- - HRK
1007
- - HTG
1008
- - HUF
1009
- - IDR
1010
- - ILS
1011
- - IMP
1012
- - INR
1013
- - IQD
1014
- - IRR
1015
- - ISK
1016
- - JEP
1017
- - JMD
1018
- - JOD
1019
- - JPY
1020
- - KES
1021
- - KGS
1022
- - KHR
1023
- - KMF
1024
- - KPW
1025
- - KRW
1026
- - KWD
1027
- - KYD
1028
- - KZT
1029
- - LAK
1030
- - LBP
1031
- - LKR
1032
- - LRD
1033
- - LSL
1034
- - LYD
1035
- - MAD
1036
- - MDL
1037
- - MGA
1038
- - MKD
1039
- - MMK
1040
- - MNT
1041
- - MOP
1042
- - MRO
1043
- - MUR
1044
- - MVR
1045
- - MWK
1046
- - MXN
1047
- - MYR
1048
- - MZN
1049
- - NAD
1050
- - NGN
1051
- - NIO
1052
- - NOK
1053
- - NPR
1054
- - NZD
1055
- - OMR
1056
- - PAB
1057
- - PEN
1058
- - PGK
1059
- - PHP
1060
- - PKR
1061
- - PLN
1062
- - PYG
1063
- - QAR
1064
- - RON
1065
- - RSD
1066
- - RUB
1067
- - RWF
1068
- - SAR
1069
- - SBD
1070
- - SCR
1071
- - SDG
1072
- - SEK
1073
- - SGD
1074
- - SHP
1075
- - SLL
1076
- - SOS
1077
- - SPL
1078
- - SRD
1079
- - STD
1080
- - SVC
1081
- - SYP
1082
- - SZL
1083
- - THB
1084
- - TJS
1085
- - TMT
1086
- - TND
1087
- - TOP
1088
- - TRY
1089
- - TTD
1090
- - TVD
1091
- - TWD
1092
- - TZS
1093
- - UAH
1094
- - UGX
1095
- - USD
1096
- - UYU
1097
- - UZS
1098
- - VEF
1099
- - VND
1100
- - VUV
1101
- - WST
1102
- - XAF
1103
- - XCD
1104
- - XDR
1105
- - XOF
1106
- - XPF
1107
- - YER
1108
- - ZAR
1109
- - ZMW
1110
- - ZWD
1111
- Date:
1112
- title: Date
1113
- type: string
1114
- pattern: >-
1115
- ^(?:[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)$
1116
- description: >-
1117
- The API data type Date is a JSON String in a lexical format that is
1118
- restricted by a regular expression for interoperability reasons. This
1119
- format, as specified in ISO 8601, contains a date only. A more readable
1120
- version of the format is yyyy-MM-dd. Examples - "1982-05-23",
1121
- "1987-08-05
1122
- DateOfBirth:
1123
- title: DateofBirth (type Date)
1124
- type: string
1125
- pattern: >-
1126
- ^(?:[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)$
1127
- description: Date of Birth of the Party.
1128
- DateTime:
1129
- title: DateTime
1130
- type: string
1131
- pattern: >-
1132
- ^(?:[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)$
1133
- description: >-
1134
- The API data type DateTime is a JSON String in a lexical format that is
1135
- restricted by a regular expression for interoperability reasons. The
1136
- format is according to ISO 8601, expressed in a combined date, time and
1137
- time zone format. A more readable version of the format is
1138
- yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples -
1139
- "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
1140
- indicates Zulu time zone, same as UTC).
1141
- ErrorCode:
1142
- title: ErrorCode
1143
- type: string
1144
- pattern: '^[1-9]\d{3}$'
1145
- description: >-
1146
- The API data type ErrorCode is a JSON String of four characters,
1147
- consisting of digits only. Negative numbers are not allowed. A leading
1148
- zero is not allowed. Each error code in the API is a four-digit number,
1149
- for example, 1234, where the first number (1 in the example) represents
1150
- the high-level error category, the second number (2 in the example)
1151
- represents the low-level error category, and the last two numbers (34 in
1152
- the example) represents the specific error.
1153
- ErrorDescription:
1154
- title: ErrorDescription
1155
- type: string
1156
- minLength: 1
1157
- maxLength: 128
1158
- description: Error description string.
1159
- ExtensionKey:
1160
- title: ExtensionKey
1161
- type: string
1162
- minLength: 1
1163
- maxLength: 32
1164
- description: Extension key.
1165
- ExtensionValue:
1166
- title: ExtensionValue
1167
- type: string
1168
- minLength: 1
1169
- maxLength: 128
1170
- description: Extension value.
1171
- FirstName:
1172
- title: FirstName
1173
- type: string
1174
- minLength: 1
1175
- maxLength: 128
1176
- pattern: '^(?!\s*$)[\w .,''-]{1,128}$'
1177
- description: First name of the Party (Name Type).
1178
- FspId:
1179
- title: FspId
1180
- type: string
1181
- minLength: 1
1182
- maxLength: 32
1183
- description: FSP identifier.
1184
- IlpCondition:
1185
- title: IlpCondition
1186
- type: string
1187
- pattern: '^[A-Za-z0-9-_]{43}$'
1188
- maxLength: 48
1189
- description: Condition that must be attached to the transfer by the Payer.
1190
- IlpFulfilment:
1191
- title: IlpFulfilment
1192
- type: string
1193
- pattern: '^[A-Za-z0-9-_]{43}$'
1194
- maxLength: 48
1195
- description: Fulfilment that must be attached to the transfer by the Payee.
1196
- IlpPacket:
1197
- title: IlpPacket
1198
- type: string
1199
- pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
1200
- minLength: 1
1201
- maxLength: 32768
1202
- description: Information for recipient (transport layer information).
1203
- Integer:
1204
- title: Integer
1205
- type: string
1206
- pattern: '^[1-9]\d*$'
1207
- description: >-
1208
- The API data type Integer is a JSON String consisting of digits only.
1209
- Negative numbers and leading zeroes are not allowed. The data type is
1210
- always limited to a specific number of digits.
1211
- LastName:
1212
- title: LastName
1213
- type: string
1214
- minLength: 1
1215
- maxLength: 128
1216
- pattern: '^(?!\s*$)[\w .,''-]{1,128}$'
1217
- description: Last name of the Party (Name Type).
1218
- Latitude:
1219
- title: Latitude
1220
- type: string
1221
- pattern: >-
1222
- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
1223
- description: >-
1224
- The API data type Latitude is a JSON String in a lexical format that is
1225
- restricted by a regular expression for interoperability reasons.
1226
- Longitude:
1227
- title: Longitude
1228
- type: string
1229
- pattern: >-
1230
- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
1231
- description: >-
1232
- The API data type Longitude is a JSON String in a lexical format that is
1233
- restricted by a regular expression for interoperability reasons.
1234
- MerchantClassificationCode:
1235
- title: MerchantClassificationCode
1236
- type: string
1237
- pattern: '^[\d]{1,4}$'
1238
- description: >-
1239
- A limited set of pre-defined numbers. This list would be a limited set
1240
- of numbers identifying a set of popular merchant types like School Fees,
1241
- Pubs and Restaurants, Groceries, etc.
1242
- MiddleName:
1243
- title: MiddleName
1244
- type: string
1245
- minLength: 1
1246
- maxLength: 128
1247
- pattern: '^(?!\s*$)[\w .,''-]{1,128}$'
1248
- description: Middle name of the Party (Name Type).
1249
- Name:
1250
- title: Name
1251
- type: string
1252
- pattern: '^(?!\s*$)[\w .,''-]{1,128}$'
1253
- description: >-
1254
- The API data type Name is a JSON String, restricted by a regular
1255
- expression to avoid characters which are generally not used in a name.
1256
- Regular Expression - The regular expression for restricting the Name
1257
- type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a
1258
- string consisting of whitespace only, all Unicode characters are
1259
- allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,)
1260
- and space characters ( ). Note - In some programming languages, Unicode
1261
- support must be specifically enabled. For example, if Java is used the
1262
- flag UNICODE_CHARACTER_CLASS must be enabled to allow Unicode
1263
- characters.
1264
- Note:
1265
- title: Note
1266
- type: string
1267
- minLength: 1
1268
- maxLength: 128
1269
- description: Memo assigned to transaction
1270
- OtpValue:
1271
- title: OtpValue
1272
- type: string
1273
- pattern: '^\d{3,10}$'
1274
- description: >-
1275
- The API data type OtpValue is a JSON String of 3 to 10 characters,
1276
- consisting of digits only. Negative numbers are not allowed. One or more
1277
- leading zeros are allowed.
1278
- PartyIdentifier:
1279
- title: PartyIdentifier
1280
- type: string
1281
- minLength: 1
1282
- maxLength: 128
1283
- description: Identifier of the Party.
1284
- PartyIdType:
1285
- title: PartyIdTypeEnum
1286
- type: string
1287
- enum:
1288
- - MSISDN
1289
- - EMAIL
1290
- - PERSONAL_ID
1291
- - BUSINESS
1292
- - DEVICE
1293
- - ACCOUNT_ID
1294
- - IBAN
1295
- - ALIAS
1296
- description: >-
1297
- Below are the allowed values for the enumeration - MSISDN An MSISDN
1298
- (Mobile Station International Subscriber Directory Number, that is, the
1299
- phone number) is used as reference to a participant. The MSISDN
1300
- identifier should be in international format according to the ITU-T
1301
- E.164 standard. Optionally, the MSISDN may be prefixed by a single plus
1302
- sign, indicating the international prefix. - EMAIL An email is used as
1303
- reference to a participant. The format of the email should be according
1304
- to the informational RFC 3696. - PERSONAL_ID A personal identifier is
1305
- used as reference to a participant. Examples of personal identification
1306
- are passport number, birth certificate number, and national registration
1307
- number. The identifier number is added in the PartyIdentifier element.
1308
- The personal identifier type is added in the PartySubIdOrType element. -
1309
- BUSINESS A specific Business (for example, an organization or a company)
1310
- is used as reference to a participant. The BUSINESS identifier can be in
1311
- any format. To make a transaction connected to a specific username or
1312
- bill number in a Business, the PartySubIdOrType element should be used.
1313
- - DEVICE A specific device (for example, a POS or ATM) ID connected to a
1314
- specific business or organization is used as reference to a Party. For
1315
- referencing a specific device under a specific business or organization,
1316
- use the PartySubIdOrType element. - ACCOUNT_ID A bank account number or
1317
- FSP account ID should be used as reference to a participant. The
1318
- ACCOUNT_ID identifier can be in any format, as formats can greatly
1319
- differ depending on country and FSP. - IBAN A bank account number or FSP
1320
- account ID is used as reference to a participant. The IBAN identifier
1321
- can consist of up to 34 alphanumeric characters and should be entered
1322
- without whitespace. - ALIAS An alias is used as reference to a
1323
- participant. The alias should be created in the FSP as an alternative
1324
- reference to an account owner. Another example of an alias is a username
1325
- in the FSP system. The ALIAS identifier can be in any format. It is also
1326
- possible to use the PartySubIdOrType element for identifying an account
1327
- under an Alias defined by the PartyIdentifier.
1328
- PartyName:
1329
- title: PartyName
1330
- type: string
1331
- minLength: 1
1332
- maxLength: 128
1333
- description: Name of the Party. Could be a real name or a nickname.
1334
- PartySubIdOrType:
1335
- title: PartySubIdOrType
1336
- type: string
1337
- minLength: 1
1338
- maxLength: 128
1339
- description: >-
1340
- Either a sub-identifier of a PartyIdentifier, or a sub-type of the
1341
- PartyIdType, normally a PersonalIdentifierType.
1342
- PersonalIdentifierType:
1343
- title: PersonalIdentifierType
1344
- type: string
1345
- enum:
1346
- - PASSPORT
1347
- - NATIONAL_REGISTRATION
1348
- - DRIVING_LICENSE
1349
- - ALIEN_REGISTRATION
1350
- - NATIONAL_ID_CARD
1351
- - EMPLOYER_ID
1352
- - TAX_ID_NUMBER
1353
- - SENIOR_CITIZENS_CARD
1354
- - MARRIAGE_CERTIFICATE
1355
- - HEALTH_CARD
1356
- - VOTERS_ID
1357
- - UNITED_NATIONS
1358
- - OTHER_ID
1359
- description: >-
1360
- Below are the allowed values for the enumeration - PASSPORT A passport
1361
- number is used as reference to a Party. - NATIONAL_REGISTRATION A
1362
- national registration number is used as reference to a Party. -
1363
- DRIVING_LICENSE A driving license is used as reference to a Party. -
1364
- ALIEN_REGISTRATION An alien registration number is used as reference to
1365
- a Party. - NATIONAL_ID_CARD A national ID card number is used as
1366
- reference to a Party. - EMPLOYER_ID A tax identification number is used
1367
- as reference to a Party. - TAX_ID_NUMBER A tax identification number is
1368
- used as reference to a Party. - SENIOR_CITIZENS_CARD A senior citizens
1369
- card number is used as reference to a Party. - MARRIAGE_CERTIFICATE A
1370
- marriage certificate number is used as reference to a Party. -
1371
- HEALTH_CARD A health card number is used as reference to a Party. -
1372
- VOTERS_ID A voter’s identification number is used as reference to a
1373
- Party. - UNITED_NATIONS An UN (United Nations) number is used as
1374
- reference to a Party. - OTHER_ID Any other type of identification type
1375
- number is used as reference to a Party.
1376
- QRCODE:
1377
- title: QRCODE
1378
- type: string
1379
- minLength: 1
1380
- maxLength: 64
1381
- description: QR code used as One Time Password.
1382
- RefundReason:
1383
- title: RefundReason
1384
- type: string
1385
- minLength: 1
1386
- maxLength: 128
1387
- description: Reason for the refund.
1388
- TokenCode:
1389
- title: TokenCode
1390
- type: string
1391
- pattern: '^[0-9a-zA-Z]{4,32}$'
1392
- description: >-
1393
- The API data type TokenCode is a JSON String between 4 and 32
1394
- characters, consisting of digits or upper or lowercase characters from a
1395
- to z.
1396
- TransactionInitiator:
1397
- title: TransactionInitiatorEnum
1398
- type: string
1399
- enum:
1400
- - PAYER
1401
- - PAYEE
1402
- description: >-
1403
- Below are the allowed values for the enumeration - PAYER Sender of funds
1404
- is initiating the transaction. The account to send from is either owned
1405
- by the Payer or is connected to the Payer in some way. - PAYEE Recipient
1406
- of the funds is initiating the transaction by sending a transaction
1407
- request. The Payer must approve the transaction, either automatically by
1408
- a pre-generated OTP or by pre-approval of the Payee, or by manually
1409
- approving in his or her own Device.
1410
- TransactionInitiatorType:
1411
- title: TransactionInitiatorTypeEnum
1412
- type: string
1413
- enum:
1414
- - CONSUMER
1415
- - AGENT
1416
- - BUSINESS
1417
- - DEVICE
1418
- description: >-
1419
- Below are the allowed values for the enumeration - CONSUMER Consumer is
1420
- the initiator of the transaction. - AGENT Agent is the initiator of the
1421
- transaction. - BUSINESS Business is the initiator of the transaction. -
1422
- DEVICE Device is the initiator of the transaction.
1423
- TransactionRequestState:
1424
- title: TransactionRequestStateEnum
1425
- type: string
1426
- enum:
1427
- - RECEIVED
1428
- - PENDING
1429
- - ACCEPTED
1430
- - REJECTED
1431
- description: >-
1432
- Below are the allowed values for the enumeration - RECEIVED Payer FSP
1433
- has received the transaction from the Payee FSP. - PENDING Payer FSP has
1434
- sent the transaction request to the Payer. - ACCEPTED Payer has approved
1435
- the transaction. - REJECTED Payer has rejected the transaction.
1436
- TransactionScenario:
1437
- title: TransactionScenarioEnum
1438
- type: string
1439
- enum:
1440
- - DEPOSIT
1441
- - WITHDRAWAL
1442
- - TRANSFER
1443
- - PAYMENT
1444
- - REFUND
1445
- description: >-
1446
- Below are the allowed values for the enumeration - DEPOSIT Used for
1447
- performing a Cash-In (deposit) transaction. In a normal scenario,
1448
- electronic funds are transferred from a Business account to a Consumer
1449
- account, and physical cash is given from the Consumer to the Business
1450
- User. - WITHDRAWAL Used for performing a Cash-Out (withdrawal)
1451
- transaction. In a normal scenario, electronic funds are transferred from
1452
- a Consumer’s account to a Business account, and physical cash is given
1453
- from the Business User to the Consumer. - TRANSFER Used for performing a
1454
- P2P (Peer to Peer, or Consumer to Consumer) transaction. - PAYMENT
1455
- Usually used for performing a transaction from a Consumer to a Merchant
1456
- or Organization, but could also be for a B2B (Business to Business)
1457
- payment. The transaction could be online for a purchase in an Internet
1458
- store, in a physical store where both the Consumer and Business User are
1459
- present, a bill payment, a donation, and so on. - REFUND Used for
1460
- performing a refund of transaction.
1461
- TransactionState:
1462
- title: TransactionStateEnum
1463
- type: string
1464
- enum:
1465
- - RECEIVED
1466
- - PENDING
1467
- - COMPLETED
1468
- - REJECTED
1469
- description: >-
1470
- Below are the allowed values for the enumeration - RECEIVED Payee FSP
1471
- has received the transaction from the Payer FSP. - PENDING Payee FSP has
1472
- validated the transaction. - COMPLETED Payee FSP has successfully
1473
- performed the transaction. - REJECTED Payee FSP has failed to perform
1474
- the transaction.
1475
- TransactionSubScenario:
1476
- title: TransactionSubScenario
1477
- type: string
1478
- pattern: '^[A-Z_]{1,32}$'
1479
- description: >-
1480
- Possible sub-scenario, defined locally within the scheme (UndefinedEnum
1481
- Type).
1482
- TransferState:
1483
- title: TransferStateEnum
1484
- type: string
1485
- enum:
1486
- - RECEIVED
1487
- - RESERVED
1488
- - COMMITTED
1489
- - ABORTED
1490
- description: >-
1491
- Below are the allowed values for the enumeration - RECEIVED Next ledger
1492
- has received the transfer. - RESERVED Next ledger has reserved the
1493
- transfer. - COMMITTED Next ledger has successfully performed the
1494
- transfer. - ABORTED Next ledger has aborted the transfer due a rejection
1495
- or failure to perform the transfer.
1496
- UndefinedEnum:
1497
- title: UndefinedEnum
1498
- type: string
1499
- pattern: '^[A-Z_]{1,32}$'
1500
- description: >-
1501
- The API data type UndefinedEnum is a JSON String consisting of 1 to 32
1502
- uppercase characters including an underscore character (_).
1503
- AuthenticationInfo:
1504
- title: AuthenticationInfo
1505
- type: object
1506
- description: Data model for the complex type AuthenticationInfo
1507
- properties:
1508
- authentication:
1509
- $ref: '#/components/schemas/AuthenticationType'
1510
- authenticationValue:
1511
- $ref: '#/components/schemas/AuthenticationValue'
1512
-
1513
- required:
1514
- - authentication
1515
- - authenticationValue
1516
- AuthorizationsIDPutResponse:
1517
- title: AuthorizationsIDPutResponse
1518
- type: object
1519
- description: 'PUT /authorizations/{ID} object'
1520
- properties:
1521
- authenticationInfo:
1522
- $ref: '#/components/schemas/AuthenticationInfo'
1523
- responseType:
1524
- $ref: '#/components/schemas/AuthorizationResponse'
1525
- required:
1526
- - responseType
1527
- BulkQuotesPostRequest:
1528
- title: BulkQuotesPostRequest
1529
- type: object
1530
- description: POST /bulkQuotes object
1531
- properties:
1532
- bulkQuoteId:
1533
- $ref: '#/components/schemas/CorrelationId'
1534
- payer:
1535
- $ref: '#/components/schemas/Party'
1536
- geoCode:
1537
- $ref: '#/components/schemas/GeoCode'
1538
- expiration:
1539
- $ref: '#/components/schemas/DateTime'
1540
- individualQuotes:
1541
- type: array
1542
- minItems: 1
1543
- maxItems: 1000
1544
- items:
1545
- $ref: '#/components/schemas/IndividualQuote'
1546
- extensionList:
1547
- $ref: '#/components/schemas/ExtensionList'
1548
- temp:
1549
- allOf:
1550
- - $ref: '#/components/schemas/IndividualQuote'
1551
- - $ref: '#/components/schemas/ExtensionList'
1552
- required:
1553
- - bulkQuoteId
1554
- - payer
1555
- - individualQuotes
1556
- BulkQuotesIDPutResponse:
1557
- title: BulkQuotesIDPutResponse
1558
- type: object
1559
- description: 'PUT /bulkQuotes/{ID} object'
1560
- properties:
1561
- individualQuoteResults:
1562
- type: array
1563
- maxItems: 1000
1564
- items:
1565
- $ref: '#/components/schemas/IndividualQuoteResult'
1566
- expiration:
1567
- $ref: '#/components/schemas/DateTime'
1568
- extensionList:
1569
- $ref: '#/components/schemas/ExtensionList'
1570
- required:
1571
- - expiration
1572
- BulkTransfersPostRequest:
1573
- title: BulkTransfersPostRequest
1574
- type: object
1575
- description: POST /bulkTransfers object
1576
- properties:
1577
- bulkTransferId:
1578
- $ref: '#/components/schemas/CorrelationId'
1579
- bulkQuoteId:
1580
- $ref: '#/components/schemas/CorrelationId'
1581
- payerFsp:
1582
- $ref: '#/components/schemas/FspId'
1583
- payeeFsp:
1584
- $ref: '#/components/schemas/FspId'
1585
- individualTransfers:
1586
- type: array
1587
- minItems: 1
1588
- maxItems: 1000
1589
- items:
1590
- $ref: '#/components/schemas/IndividualTransfer'
1591
- expiration:
1592
- $ref: '#/components/schemas/DateTime'
1593
- extensionList:
1594
- $ref: '#/components/schemas/ExtensionList'
1595
- required:
1596
- - bulkTransferId
1597
- - bulkQuoteId
1598
- - payerFsp
1599
- - payeeFsp
1600
- - individualTransfers
1601
- - expiration
1602
- BulkTransfersIDPutResponse:
1603
- title: BulkTransfersIDPutResponse
1604
- type: object
1605
- description: 'PUT /bulkTransfers/{ID} object'
1606
- properties:
1607
- completedTimestamp:
1608
- $ref: '#/components/schemas/DateTime'
1609
- individualTransferResults:
1610
- type: array
1611
- maxItems: 1000
1612
- items:
1613
- $ref: '#/components/schemas/IndividualTransferResult'
1614
- bulkTransferState:
1615
- $ref: '#/components/schemas/BulkTransferState'
1616
- extensionList:
1617
- $ref: '#/components/schemas/ExtensionList'
1618
- required:
1619
- - bulkTransferState
1620
- ErrorInformation:
1621
- title: ErrorInformation
1622
- type: object
1623
- description: Data model for the complex type ErrorInformation.
1624
- properties:
1625
- errorCode:
1626
- $ref: '#/components/schemas/ErrorCode'
1627
- errorDescription:
1628
- $ref: '#/components/schemas/ErrorDescription'
1629
- extensionList:
1630
- $ref: '#/components/schemas/ExtensionList'
1631
- required:
1632
- - errorCode
1633
- - errorDescription
1634
- ErrorInformationObject:
1635
- title: ErrorInformationObject
1636
- type: object
1637
- description: Data model for the complex type object that contains ErrorInformation.
1638
- properties:
1639
- errorInformation:
1640
- $ref: '#/components/schemas/ErrorInformation'
1641
- required:
1642
- - errorInformation
1643
- ErrorInformationResponse:
1644
- title: ErrorInformationResponse
1645
- type: object
1646
- description: >-
1647
- Data model for the complex type object that contains an optional element
1648
- ErrorInformation used along with 4xx and 5xx responses.
1649
- properties:
1650
- errorInformation:
1651
- $ref: '#/components/schemas/ErrorInformation'
1652
- Extension:
1653
- title: Extension
1654
- type: object
1655
- description: Data model for the complex type Extension
1656
- properties:
1657
- key:
1658
- $ref: '#/components/schemas/ExtensionKey'
1659
- value:
1660
- $ref: '#/components/schemas/ExtensionValue'
1661
- required:
1662
- - key
1663
- - value
1664
- ExtensionList:
1665
- title: ExtensionList
1666
- type: object
1667
- description: Data model for the complex type ExtensionList
1668
- properties:
1669
- extension:
1670
- type: array
1671
- items:
1672
- $ref: '#/components/schemas/Extension'
1673
- minItems: 1
1674
- maxItems: 16
1675
- description: Number of Extension elements
1676
- required:
1677
- - extension
1678
- GeoCode:
1679
- title: GeoCode
1680
- type: object
1681
- description: >-
1682
- Data model for the complex type GeoCode. Indicates the geographic
1683
- location from where the transaction was initiated.
1684
- properties:
1685
- latitude:
1686
- $ref: '#/components/schemas/Latitude'
1687
- longitude:
1688
- $ref: '#/components/schemas/Longitude'
1689
- required:
1690
- - latitude
1691
- - longitude
1692
- IndividualQuote:
1693
- title: IndividualQuote
1694
- type: object
1695
- description: Data model for the complex type IndividualQuote.
1696
- properties:
1697
- quoteId:
1698
- $ref: '#/components/schemas/CorrelationId'
1699
- transactionId:
1700
- $ref: '#/components/schemas/CorrelationId'
1701
- payee:
1702
- $ref: '#/components/schemas/Party'
1703
- amountType:
1704
- $ref: '#/components/schemas/AmountType'
1705
- amount:
1706
- $ref: '#/components/schemas/Money'
1707
- fees:
1708
- $ref: '#/components/schemas/Money'
1709
- transactionType:
1710
- $ref: '#/components/schemas/TransactionType'
1711
- note:
1712
- $ref: '#/components/schemas/Note'
1713
- extensionList:
1714
- $ref: '#/components/schemas/ExtensionList'
1715
- required:
1716
- - quoteId
1717
- - transactionId
1718
- - payee
1719
- - amountType
1720
- - amount
1721
- - transactionType
1722
- IndividualQuoteResult:
1723
- title: IndividualQuoteResult
1724
- type: object
1725
- description: Data model for the complex type IndividualQuoteResult.
1726
- properties:
1727
- quoteId:
1728
- $ref: '#/components/schemas/CorrelationId'
1729
- payee:
1730
- $ref: '#/components/schemas/Party'
1731
- transferAmount:
1732
- $ref: '#/components/schemas/Money'
1733
- payeeReceiveAmount:
1734
- $ref: '#/components/schemas/Money'
1735
- payeeFspFee:
1736
- $ref: '#/components/schemas/Money'
1737
- payeeFspCommission:
1738
- $ref: '#/components/schemas/Money'
1739
- ilpPacket:
1740
- $ref: '#/components/schemas/IlpPacket'
1741
- condition:
1742
- $ref: '#/components/schemas/IlpCondition'
1743
- errorInformation:
1744
- $ref: '#/components/schemas/ErrorInformation'
1745
- extensionList:
1746
- $ref: '#/components/schemas/ExtensionList'
1747
- required:
1748
- - quoteId
1749
- IndividualTransfer:
1750
- title: IndividualTransfer
1751
- type: object
1752
- description: Data model for the complex type IndividualTransfer.
1753
- properties:
1754
- transferId:
1755
- $ref: '#/components/schemas/CorrelationId'
1756
- transferAmount:
1757
- $ref: '#/components/schemas/Money'
1758
- ilpPacket:
1759
- $ref: '#/components/schemas/IlpPacket'
1760
- condition:
1761
- $ref: '#/components/schemas/IlpCondition'
1762
- extensionList:
1763
- $ref: '#/components/schemas/ExtensionList'
1764
- required:
1765
- - transferId
1766
- - transferAmount
1767
- - ilpPacket
1768
- - condition
1769
- IndividualTransferResult:
1770
- title: IndividualTransferResult
1771
- type: object
1772
- description: Data model for the complex type IndividualTransferResult.
1773
- properties:
1774
- transferId:
1775
- $ref: '#/components/schemas/CorrelationId'
1776
- fulfilment:
1777
- $ref: '#/components/schemas/IlpFulfilment'
1778
- errorInformation:
1779
- $ref: '#/components/schemas/ErrorInformation'
1780
- extensionList:
1781
- $ref: '#/components/schemas/ExtensionList'
1782
- required:
1783
- - transferId
1784
- Money:
1785
- title: Money
1786
- type: object
1787
- description: Data model for the complex type Money.
1788
- properties:
1789
- currency:
1790
- $ref: '#/components/schemas/Currency'
1791
- amount:
1792
- $ref: '#/components/schemas/Amount'
1793
- required:
1794
- - currency
1795
- - amount
1796
- ParticipantsTypeIDSubIDPostRequest:
1797
- title: ParticipantsTypeIDSubIDPostRequest
1798
- type: object
1799
- description: 'POST /participants/{Type}/{ID}/{SubId}, /participants/{Type}/{ID} object'
1800
- properties:
1801
- fspId:
1802
- $ref: '#/components/schemas/FspId'
1803
- currency:
1804
- $ref: '#/components/schemas/Currency'
1805
- required:
1806
- - fspId
1807
- ParticipantsTypeIDPutResponse:
1808
- title: ParticipantsTypeIDPutResponse
1809
- type: object
1810
- description: 'PUT /participants/{Type}/{ID}/{SubId}, /participants/{Type}/{ID} object'
1811
- properties:
1812
- fspId:
1813
- $ref: '#/components/schemas/FspId'
1814
- ParticipantsIDPutResponse:
1815
- title: ParticipantsIDPutResponse
1816
- type: object
1817
- description: 'PUT /participants/{ID} object'
1818
- properties:
1819
- partyList:
1820
- type: array
1821
- items:
1822
- $ref: '#/components/schemas/PartyResult'
1823
- minItems: 1
1824
- maxItems: 10000
1825
- description: >-
1826
- List of PartyResult elements that were either created or failed to
1827
- be created.
1828
- currency:
1829
- $ref: '#/components/schemas/Currency'
1830
- required:
1831
- - partyList
1832
- ParticipantsPostRequest:
1833
- title: ParticipantsPostRequest
1834
- type: object
1835
- description: POST /participants object
1836
- properties:
1837
- requestId:
1838
- $ref: '#/components/schemas/CorrelationId'
1839
- partyList:
1840
- type: array
1841
- items:
1842
- $ref: '#/components/schemas/PartyIdInfo'
1843
- minItems: 1
1844
- maxItems: 10000
1845
- description: >-
1846
- List of PartyIdInfo elements that the client would like to update or
1847
- create FSP information about.
1848
- currency:
1849
- $ref: '#/components/schemas/Currency'
1850
- required:
1851
- - requestId
1852
- - partyList
1853
- Party:
1854
- title: Party
1855
- type: object
1856
- description: Data model for the complex type Party.
1857
- properties:
1858
- partyIdInfo:
1859
- $ref: '#/components/schemas/PartyIdInfo'
1860
- merchantClassificationCode:
1861
- $ref: '#/components/schemas/MerchantClassificationCode'
1862
- name:
1863
- $ref: '#/components/schemas/PartyName'
1864
- personalInfo:
1865
- $ref: '#/components/schemas/PartyPersonalInfo'
1866
- required:
1867
- - partyIdInfo
1868
- PartyComplexName:
1869
- title: PartyComplexName
1870
- type: object
1871
- description: Data model for the complex type PartyComplexName.
1872
- properties:
1873
- firstName:
1874
- $ref: '#/components/schemas/FirstName'
1875
- middleName:
1876
- $ref: '#/components/schemas/MiddleName'
1877
- lastName:
1878
- $ref: '#/components/schemas/LastName'
1879
- PartyIdInfo:
1880
- title: PartyIdInfo
1881
- type: object
1882
- description: Data model for the complex type PartyIdInfo.
1883
- properties:
1884
- partyIdType:
1885
- $ref: '#/components/schemas/PartyIdType'
1886
- partyIdentifier:
1887
- $ref: '#/components/schemas/PartyIdentifier'
1888
- partySubIdOrType:
1889
- $ref: '#/components/schemas/PartySubIdOrType'
1890
- fspId:
1891
- $ref: '#/components/schemas/FspId'
1892
- required:
1893
- - partyIdType
1894
- - partyIdentifier
1895
- PartiesTypeIDPutResponse:
1896
- title: PartiesTypeIDPutResponse
1897
- type: object
1898
- description: 'PUT /parties/{Type}/{ID} object'
1899
- properties:
1900
- party:
1901
- $ref: '#/components/schemas/Party'
1902
- required:
1903
- - party
1904
- PartyPersonalInfo:
1905
- title: PartyPersonalInfo
1906
- type: object
1907
- description: Data model for the complex type PartyPersonalInfo.
1908
- properties:
1909
- complexName:
1910
- $ref: '#/components/schemas/PartyComplexName'
1911
- dateOfBirth:
1912
- $ref: '#/components/schemas/DateOfBirth'
1913
- PartyResult:
1914
- title: PartyResult
1915
- type: object
1916
- description: Data model for the complex type PartyResult.
1917
- properties:
1918
- partyId:
1919
- $ref: '#/components/schemas/PartyIdInfo'
1920
- errorInformation:
1921
- $ref: '#/components/schemas/ErrorInformation'
1922
- required:
1923
- - partyId
1924
- QuotesPostRequest:
1925
- title: QuotesPostRequest
1926
- type: object
1927
- description: POST /quotes object
1928
- properties:
1929
- quoteId:
1930
- $ref: '#/components/schemas/CorrelationId'
1931
- transactionId:
1932
- $ref: '#/components/schemas/CorrelationId'
1933
- transactionRequestId:
1934
- $ref: '#/components/schemas/CorrelationId'
1935
- payee:
1936
- $ref: '#/components/schemas/Party'
1937
- payer:
1938
- $ref: '#/components/schemas/Party'
1939
- amountType:
1940
- $ref: '#/components/schemas/AmountType'
1941
- amount:
1942
- $ref: '#/components/schemas/Money'
1943
- fees:
1944
- $ref: '#/components/schemas/Money'
1945
- transactionType:
1946
- $ref: '#/components/schemas/TransactionType'
1947
- geoCode:
1948
- $ref: '#/components/schemas/GeoCode'
1949
- note:
1950
- $ref: '#/components/schemas/Note'
1951
- expiration:
1952
- $ref: '#/components/schemas/DateTime'
1953
- extensionList:
1954
- $ref: '#/components/schemas/ExtensionList'
1955
- required:
1956
- - quoteId
1957
- - transactionId
1958
- - payee
1959
- - payer
1960
- - amountType
1961
- - amount
1962
- - transactionType
1963
- QuotesIDPutResponse:
1964
- title: QuotesIDPutResponse
1965
- type: object
1966
- description: 'PUT /quotes/{ID} object'
1967
- properties:
1968
- transferAmount:
1969
- $ref: '#/components/schemas/Money'
1970
- payeeReceiveAmount:
1971
- $ref: '#/components/schemas/Money'
1972
- payeeFspFee:
1973
- $ref: '#/components/schemas/Money'
1974
- payeeFspCommission:
1975
- $ref: '#/components/schemas/Money'
1976
- expiration:
1977
- $ref: '#/components/schemas/DateTime'
1978
- geoCode:
1979
- $ref: '#/components/schemas/GeoCode'
1980
- ilpPacket:
1981
- $ref: '#/components/schemas/IlpPacket'
1982
- condition:
1983
- $ref: '#/components/schemas/IlpCondition'
1984
- extensionList:
1985
- $ref: '#/components/schemas/ExtensionList'
1986
- required:
1987
- - transferAmount
1988
- - expiration
1989
- - ilpPacket
1990
- - condition
1991
- Refund:
1992
- title: Refund
1993
- type: object
1994
- description: Data model for the complex type Refund.
1995
- properties:
1996
- originalTransactionId:
1997
- $ref: '#/components/schemas/CorrelationId'
1998
- refundReason:
1999
- $ref: '#/components/schemas/RefundReason'
2000
- required:
2001
- - originalTransactionId
2002
- Transaction:
2003
- title: Transaction
2004
- type: object
2005
- description: >-
2006
- Data model for the complex type Transaction. The Transaction type is
2007
- used to carry end-to-end data between the Payer FSP and the Payee FSP in
2008
- the ILP Packet. Both the transactionId and the quoteId in the data model
2009
- are decided by the Payer FSP in the POST /quotes.
2010
- properties:
2011
- transactionId:
2012
- $ref: '#/components/schemas/CorrelationId'
2013
- quoteId:
2014
- $ref: '#/components/schemas/CorrelationId'
2015
- payee:
2016
- $ref: '#/components/schemas/Party'
2017
- payer:
2018
- $ref: '#/components/schemas/Party'
2019
- amount:
2020
- $ref: '#/components/schemas/Money'
2021
- transactionType:
2022
- $ref: '#/components/schemas/TransactionType'
2023
- note:
2024
- $ref: '#/components/schemas/Note'
2025
- extensionList:
2026
- $ref: '#/components/schemas/ExtensionList'
2027
- required:
2028
- - transactionId
2029
- - quoteId
2030
- - payee
2031
- - payer
2032
- - amount
2033
- - transactionType
2034
- TransactionRequestsIDPutResponse:
2035
- title: TransactionRequestsIDPutResponse
2036
- type: object
2037
- description: 'PUT /transactionRequests/{ID} object'
2038
- properties:
2039
- transactionId:
2040
- $ref: '#/components/schemas/CorrelationId'
2041
- transactionRequestState:
2042
- $ref: '#/components/schemas/TransactionRequestState'
2043
- extensionList:
2044
- $ref: '#/components/schemas/ExtensionList'
2045
- required:
2046
- - transactionRequestState
2047
- TransactionsIDPutResponse:
2048
- title: TransactionsIDPutResponse
2049
- type: object
2050
- description: 'PUT /transactions/{ID} object'
2051
- properties:
2052
- completedTimestamp:
2053
- $ref: '#/components/schemas/DateTime'
2054
- transactionState:
2055
- $ref: '#/components/schemas/TransactionState'
2056
- code:
2057
- $ref: '#/components/schemas/Code'
2058
- extensionList:
2059
- $ref: '#/components/schemas/ExtensionList'
2060
- required:
2061
- - transactionState
2062
- TransactionType:
2063
- title: TransactionType
2064
- type: object
2065
- description: Data model for the complex type TransactionType.
2066
- properties:
2067
- scenario:
2068
- $ref: '#/components/schemas/TransactionScenario'
2069
- subScenario:
2070
- $ref: '#/components/schemas/TransactionSubScenario'
2071
- initiator:
2072
- $ref: '#/components/schemas/TransactionInitiator'
2073
- initiatorType:
2074
- $ref: '#/components/schemas/TransactionInitiatorType'
2075
- refundInfo:
2076
- $ref: '#/components/schemas/Refund'
2077
- balanceOfPayments:
2078
- $ref: '#/components/schemas/BalanceOfPayments'
2079
- required:
2080
- - scenario
2081
- - initiator
2082
- - initiatorType
2083
- TransfersPostRequest:
2084
- title: TransfersPostRequest
2085
- type: object
2086
- description: POST /transfers Request object
2087
- properties:
2088
- transferId:
2089
- $ref: '#/components/schemas/CorrelationId'
2090
- payeeFsp:
2091
- $ref: '#/components/schemas/FspId'
2092
- payerFsp:
2093
- $ref: '#/components/schemas/FspId'
2094
- amount:
2095
- $ref: '#/components/schemas/Money'
2096
- ilpPacket:
2097
- $ref: '#/components/schemas/IlpPacket'
2098
- condition:
2099
- $ref: '#/components/schemas/IlpCondition'
2100
- expiration:
2101
- $ref: '#/components/schemas/DateTime'
2102
- extensionList:
2103
- $ref: '#/components/schemas/ExtensionList'
2104
- required:
2105
- - transferId
2106
- - payeeFsp
2107
- - payerFsp
2108
- - amount
2109
- - ilpPacket
2110
- - condition
2111
- - expiration
2112
- TransactionRequestsPostRequest:
2113
- title: TransactionRequestsPostRequest
2114
- type: object
2115
- description: POST /transactionRequests object
2116
- properties:
2117
- transactionRequestId:
2118
- $ref: '#/components/schemas/CorrelationId'
2119
- payee:
2120
- $ref: '#/components/schemas/Party'
2121
- payer:
2122
- $ref: '#/components/schemas/PartyIdInfo'
2123
- amount:
2124
- $ref: '#/components/schemas/Money'
2125
- transactionType:
2126
- $ref: '#/components/schemas/TransactionType'
2127
- note:
2128
- $ref: '#/components/schemas/Note'
2129
- geoCode:
2130
- $ref: '#/components/schemas/GeoCode'
2131
- authenticationType:
2132
- $ref: '#/components/schemas/AuthenticationType'
2133
- expiration:
2134
- $ref: '#/components/schemas/DateTime'
2135
- extensionList:
2136
- $ref: '#/components/schemas/ExtensionList'
2137
- required:
2138
- - transactionRequestId
2139
- - payee
2140
- - payer
2141
- - amount
2142
- - transactionType
2143
- TransfersIDPutResponse:
2144
- title: TransfersIDPutResponse
2145
- type: object
2146
- description: 'PUT /transfers/{ID} object'
2147
- properties:
2148
- fulfilment:
2149
- $ref: '#/components/schemas/IlpFulfilment'
2150
- completedTimestamp:
2151
- $ref: '#/components/schemas/DateTime'
2152
- transferState:
2153
- $ref: '#/components/schemas/TransferState'
2154
- extensionList:
2155
- $ref: '#/components/schemas/ExtensionList'
2156
- required:
2157
- - transferState