@mojaloop/api-snippets 17.0.0 → 17.0.1

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.
Files changed (26) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +2673 -0
  3. package/lib/example.d.ts +1 -1
  4. package/lib/sdk-scheme-adapter/v2_0_0/{inbound → backend}/index.d.ts +0 -0
  5. package/lib/sdk-scheme-adapter/v2_0_0/{inbound → backend}/index.js +0 -0
  6. package/lib/sdk-scheme-adapter/v2_0_0/{inbound → backend}/index.js.map +1 -1
  7. package/lib/sdk-scheme-adapter/v2_0_0/{inbound → backend}/json-schemas.json +8987 -8769
  8. package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +4391 -0
  9. package/lib/sdk-scheme-adapter/v2_0_0/{inbound → backend}/openapi.js +0 -0
  10. package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.js.map +1 -0
  11. package/lib/sdk-scheme-adapter/v2_0_0/{inbound → backend}/schemas.d.ts +3158 -3295
  12. package/lib/sdk-scheme-adapter/v2_0_0/{inbound → backend}/schemas.js +51 -58
  13. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -0
  14. package/lib/sdk-scheme-adapter/v2_0_0/{inbound → backend}/types.d.ts +51 -58
  15. package/lib/sdk-scheme-adapter/v2_0_0/{inbound → backend}/types.js +0 -0
  16. package/lib/sdk-scheme-adapter/v2_0_0/backend/types.js.map +1 -0
  17. package/lib/sdk-scheme-adapter/v2_0_0/index.d.ts +2 -2
  18. package/lib/sdk-scheme-adapter/v2_0_0/index.js +3 -3
  19. package/package.json +22 -22
  20. package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml +1704 -0
  21. package/docs/sdk-scheme-adapter-inbound-v2_0_0-openapi3-snippets.yaml +0 -2889
  22. package/lib/sdk-scheme-adapter/v2_0_0/inbound/openapi.d.ts +0 -4350
  23. package/lib/sdk-scheme-adapter/v2_0_0/inbound/openapi.js.map +0 -1
  24. package/lib/sdk-scheme-adapter/v2_0_0/inbound/schemas.js.map +0 -1
  25. package/lib/sdk-scheme-adapter/v2_0_0/inbound/types.js.map +0 -1
  26. package/sdk-scheme-adapter/v2_0_0/inbound/openapi.yaml +0 -1074
package/docs/sdk-scheme-adapter-inbound-v2_0_0-openapi3-snippets.yaml DELETED
@@ -1,2889 +0,0 @@
1
- openapi: 3.0.1
2
- info:
3
- title: Mojaloop SDK Inbound Scheme Adapter API
4
- description: >
5
- API specification for the Mojaloop SDK Inbound Scheme Adapter API – to be
6
- implemented by the Digital Financial Service Provider's (DFSP) backend.
7
-
8
-
9
- **Note on terminology:** The term "Switch" is equal to the term "Hub", and
10
- the term "FSP" is equal to the term "DFSP".
11
- license:
12
- name: Apache License Version 2.0, January 2004
13
- url: http://www.apache.org/licenses/
14
- version: 1.1.0
15
- paths:
16
- /participants/{idType}/{idValue}:
17
- get:
18
- summary: >-
19
- Asks for the identifier (fspId) of the scheme participant (FSP) that can
20
- handle transfers for the specified identifier type and value
21
- description: >-
22
- The HTTP request `GET /participants/{idType}/{idValue}` is used to find
23
- out in which FSP the requested party, defined by `{idType}` and
24
- `{idValue}`, is located.
25
- tags:
26
- - Participants
27
- parameters:
28
- - name: idType
29
- in: path
30
- required: true
31
- schema: &ref_2
32
- type: string
33
- enum:
34
- - MSISDN
35
- - ACCOUNT_ID
36
- description: >
37
- Below are the allowed values for the enumeration.
38
-
39
-
40
- - MSISDN - An MSISDN (Mobile Station International Subscriber
41
- Directory Number, that is, the phone number) is used as reference to
42
- a participant. The MSISDN identifier should be in international
43
- format according to the [ITU-T E.164
44
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
45
- MSISDN may be prefixed by a single plus sign, indicating the
46
- international prefix.
47
-
48
-
49
- - ACCOUNT_ID - A bank account number or FSP account ID should be
50
- used as reference to a participant. The ACCOUNT_ID identifier can be
51
- in any format, as formats can greatly differ depending on country
52
- and FSP.
53
- - name: idValue
54
- in: path
55
- required: true
56
- schema: &ref_3
57
- type: string
58
- minLength: 1
59
- maxLength: 128
60
- description: Identifier of the party.
61
- responses:
62
- '200':
63
- description: Response containing details of the requested party
64
- content:
65
- application/json:
66
- schema:
67
- type: object
68
- properties: &ref_4
69
- fspId:
70
- type: string
71
- minLength: 1
72
- maxLength: 32
73
- description: FSP identifier.
74
- '400':
75
- description: Malformed or missing required headers or parameters
76
- content: &ref_5
77
- application/json:
78
- schema:
79
- type: object
80
- required: &ref_0
81
- - statusCode
82
- properties: &ref_1
83
- statusCode:
84
- type: string
85
- description: Error code as string.
86
- message:
87
- type: string
88
- description: Error message text.
89
- '404':
90
- description: >-
91
- The party specified by the provided identifier type and value is not
92
- known to the server
93
- '500':
94
- description: An error occurred processing the request
95
- content: &ref_6
96
- application/json:
97
- schema:
98
- type: object
99
- required: *ref_0
100
- properties: *ref_1
101
- /participants/{idType}/{idValue}/{idSubValue}:
102
- get:
103
- summary: >-
104
- Asks for the identifier (fspId) of the scheme participant (FSP) that can
105
- handle transfers for the specified identifier type and value
106
- description: >-
107
- The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is
108
- used to find out in which FSP the requested party, defined by
109
- `{idType}`, `{idValue}` and `{idSubValue}` is located.
110
- tags:
111
- - Participants
112
- parameters:
113
- - name: idType
114
- in: path
115
- required: true
116
- schema: *ref_2
117
- description: >
118
- Below are the allowed values for the enumeration.
119
-
120
-
121
- - MSISDN - An MSISDN (Mobile Station International Subscriber
122
- Directory Number, that is, the phone number) is used as reference to
123
- a participant. The MSISDN identifier should be in international
124
- format according to the [ITU-T E.164
125
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
126
- MSISDN may be prefixed by a single plus sign, indicating the
127
- international prefix.
128
-
129
-
130
- - ACCOUNT_ID - A bank account number or FSP account ID should be
131
- used as reference to a participant. The ACCOUNT_ID identifier can be
132
- in any format, as formats can greatly differ depending on country
133
- and FSP.
134
- - name: idValue
135
- in: path
136
- required: true
137
- schema: *ref_3
138
- description: Identifier of the party.
139
- - name: idSubValue
140
- in: path
141
- required: true
142
- schema: &ref_7
143
- type: string
144
- minLength: 1
145
- maxLength: 128
146
- description: >-
147
- Either a sub-identifier of a `{idValue}`, or a sub-type of the
148
- `{idType}`, normally a `{personalIdType}`
149
- responses:
150
- '200':
151
- description: Response containing details of the requested party
152
- content:
153
- application/json:
154
- schema:
155
- type: object
156
- properties: *ref_4
157
- '400':
158
- description: Malformed or missing required headers or parameters
159
- content: *ref_5
160
- '404':
161
- description: >-
162
- The party specified by the provided identifier type and value is not
163
- known to the server
164
- '500':
165
- description: An error occurred processing the request
166
- content: *ref_6
167
- /parties/{idType}/{idValue}:
168
- get:
169
- summary: >-
170
- Requests information relating to a transfer party identified by the
171
- specified identifier type and value
172
- description: >-
173
- The HTTP request `GET /parties/{idType}/{idValue}` is used to look up
174
- information regarding the requested transfer party, identified by
175
- `{idType}` and `{idValue}`.
176
- tags:
177
- - Parties
178
- parameters:
179
- - name: idType
180
- in: path
181
- required: true
182
- schema: *ref_2
183
- description: >
184
- Below are the allowed values for the enumeration.
185
-
186
-
187
- - MSISDN - An MSISDN (Mobile Station International Subscriber
188
- Directory Number, that is, the phone number) is used as reference to
189
- a participant. The MSISDN identifier should be in international
190
- format according to the [ITU-T E.164
191
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
192
- MSISDN may be prefixed by a single plus sign, indicating the
193
- international prefix.
194
-
195
-
196
- - ACCOUNT_ID - A bank account number or FSP account ID should be
197
- used as reference to a participant. The ACCOUNT_ID identifier can be
198
- in any format, as formats can greatly differ depending on country
199
- and FSP.
200
- - name: idValue
201
- in: path
202
- required: true
203
- schema: *ref_3
204
- description: Identifier of the party.
205
- responses:
206
- '200':
207
- description: Response containing details of the requested party
208
- content:
209
- application/json:
210
- schema:
211
- type: object
212
- required: &ref_8
213
- - idType
214
- - idValue
215
- properties: &ref_9
216
- type:
217
- type: string
218
- enum: &ref_29
219
- - CONSUMER
220
- - AGENT
221
- - BUSINESS
222
- - DEVICE
223
- idType:
224
- type: string
225
- enum: &ref_27
226
- - MSISDN
227
- - ACCOUNT_ID
228
- description: >
229
- Below are the allowed values for the enumeration.
230
-
231
-
232
- - MSISDN - An MSISDN (Mobile Station International
233
- Subscriber Directory Number, that is, the phone number) is
234
- used as reference to a participant. The MSISDN identifier
235
- should be in international format according to the [ITU-T
236
- E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
237
- Optionally, the MSISDN may be prefixed by a single plus
238
- sign, indicating the international prefix.
239
-
240
-
241
- - ACCOUNT_ID - A bank account number or FSP account ID
242
- should be used as reference to a participant. The
243
- ACCOUNT_ID identifier can be in any format, as formats can
244
- greatly differ depending on country and FSP.
245
- idValue:
246
- type: string
247
- description: The identifier string used to identify the sender.
248
- idSubValue:
249
- type: string
250
- minLength: 1
251
- maxLength: 128
252
- description: >-
253
- Either a sub-identifier of a `{idValue}`, or a sub-type of
254
- the `{idType}`, normally a `{personalIdType}`
255
- displayName:
256
- type: string
257
- description: Display name of the sender, if known.
258
- firstName:
259
- type: string
260
- description: Party first name.
261
- middleName:
262
- type: string
263
- description: Party middle name.
264
- lastName:
265
- type: string
266
- description: Party last name.
267
- dateOfBirth:
268
- type: string
269
- pattern: >-
270
- ^(?:[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)$
271
- description: Date of birth in the form YYYY-MM-DD.
272
- merchantClassificationCode:
273
- type: string
274
- description: >-
275
- Up to 4 digits specifying the sender's merchant
276
- classification, if known and applicable.
277
- fspId:
278
- type: string
279
- description: >-
280
- Mojaloop scheme FSPID of the DFSP which owns the party
281
- account.
282
- extensionList:
283
- type: array
284
- items: &ref_11
285
- type: object
286
- properties: &ref_28
287
- key:
288
- type: string
289
- minLength: 1
290
- maxLength: 32
291
- value:
292
- type: string
293
- minLength: 1
294
- maxLength: 128
295
- minItems: 0
296
- maxItems: 16
297
- '400':
298
- description: Malformed or missing required headers or parameters
299
- content: *ref_5
300
- '404':
301
- description: >-
302
- The party specified by the provided identifier type and value is not
303
- known to the server
304
- '500':
305
- description: An error occurred processing the request
306
- content: *ref_6
307
- /parties/{idType}/{idValue}/{idSubValue}:
308
- get:
309
- summary: >-
310
- Requests information relating to a transfer party identified by the
311
- specified identifier type and value
312
- description: >-
313
- The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used
314
- to look up information regarding the requested transfer party,
315
- identified by `{idType}`, `{idValue}` and `{idSubValue}`.
316
- tags:
317
- - Parties
318
- parameters:
319
- - name: idType
320
- in: path
321
- required: true
322
- schema: *ref_2
323
- description: >
324
- Below are the allowed values for the enumeration.
325
-
326
-
327
- - MSISDN - An MSISDN (Mobile Station International Subscriber
328
- Directory Number, that is, the phone number) is used as reference to
329
- a participant. The MSISDN identifier should be in international
330
- format according to the [ITU-T E.164
331
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
332
- MSISDN may be prefixed by a single plus sign, indicating the
333
- international prefix.
334
-
335
-
336
- - ACCOUNT_ID - A bank account number or FSP account ID should be
337
- used as reference to a participant. The ACCOUNT_ID identifier can be
338
- in any format, as formats can greatly differ depending on country
339
- and FSP.
340
- - name: idValue
341
- in: path
342
- required: true
343
- schema: *ref_3
344
- description: Identifier of the party.
345
- - name: idSubValue
346
- in: path
347
- required: true
348
- schema: *ref_7
349
- description: >-
350
- Either a sub-identifier of a `{idValue}`, or a sub-type of the
351
- `{idType}`, normally a `{personalIdType}`
352
- responses:
353
- '200':
354
- description: Response containing details of the requested party
355
- content:
356
- application/json:
357
- schema:
358
- type: object
359
- required: *ref_8
360
- properties: *ref_9
361
- '400':
362
- description: Malformed or missing required headers or parameters
363
- content: *ref_5
364
- '404':
365
- description: >-
366
- The party specified by the provided identifier type and value is not
367
- known to the server
368
- '500':
369
- description: An error occurred processing the request
370
- content: *ref_6
371
- /quoterequests:
372
- post:
373
- summary: Requests a quote for the specified transfer
374
- description: >-
375
- The HTTP request `POST /quoterequests` is used to request the creation
376
- of a quote for the provided financial transaction.
377
- tags:
378
- - Quotes
379
- requestBody:
380
- description: Request for a transfer quotation
381
- content:
382
- application/json:
383
- schema:
384
- type: object
385
- description: A request for a quote for transfer from the DFSP backend.
386
- required: &ref_30
387
- - quoteId
388
- - transactionId
389
- - to
390
- - from
391
- - amountType
392
- - amount
393
- - currency
394
- - transactionType
395
- - initiator
396
- - initiatorType
397
- properties: &ref_31
398
- quoteId:
399
- pattern: >-
400
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
401
- type: string
402
- description: A Mojaloop API quote identifier (UUID).
403
- transactionId:
404
- description: >-
405
- ID of the transaction, the ID is decided by the Payer FSP
406
- during the creation of the quote.
407
- pattern: >-
408
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
409
- type: string
410
- to:
411
- description: >-
412
- Information about the Payee in the proposed financial
413
- transaction.
414
- type: object
415
- required: *ref_8
416
- properties: *ref_9
417
- from:
418
- description: >-
419
- Information about the Payer in the proposed financial
420
- transaction.
421
- type: object
422
- required: *ref_8
423
- properties: *ref_9
424
- amountType:
425
- description: SEND for send amount, RECEIVE for receive amount.
426
- type: string
427
- enum: &ref_16
428
- - SEND
429
- - RECEIVE
430
- amount:
431
- description: >-
432
- Depending on `amountType`. If SEND - The amount the Payer
433
- would like to send, that is, the amount that should be
434
- withdrawn from the Payer account including any fees. The
435
- amount is updated by each participating entity in the
436
- transaction. If RECEIVE - The amount the Payee should
437
- receive, that is, the amount that should be sent to the
438
- receiver exclusive any fees. The amount is not updated by
439
- any of the participating entities.
440
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
441
- type: string
442
- currency:
443
- maxLength: 3
444
- minLength: 3
445
- type: string
446
- enum: &ref_10
447
- - AED
448
- - AFN
449
- - ALL
450
- - AMD
451
- - ANG
452
- - AOA
453
- - ARS
454
- - AUD
455
- - AWG
456
- - AZN
457
- - BAM
458
- - BBD
459
- - BDT
460
- - BGN
461
- - BHD
462
- - BIF
463
- - BMD
464
- - BND
465
- - BOB
466
- - BRL
467
- - BSD
468
- - BTN
469
- - BWP
470
- - BYN
471
- - BZD
472
- - CAD
473
- - CDF
474
- - CHF
475
- - CLP
476
- - CNY
477
- - COP
478
- - CRC
479
- - CUC
480
- - CUP
481
- - CVE
482
- - CZK
483
- - DJF
484
- - DKK
485
- - DOP
486
- - DZD
487
- - EGP
488
- - ERN
489
- - ETB
490
- - EUR
491
- - FJD
492
- - FKP
493
- - GBP
494
- - GEL
495
- - GGP
496
- - GHS
497
- - GIP
498
- - GMD
499
- - GNF
500
- - GTQ
501
- - GYD
502
- - HKD
503
- - HNL
504
- - HRK
505
- - HTG
506
- - HUF
507
- - IDR
508
- - ILS
509
- - IMP
510
- - INR
511
- - IQD
512
- - IRR
513
- - ISK
514
- - JEP
515
- - JMD
516
- - JOD
517
- - JPY
518
- - KES
519
- - KGS
520
- - KHR
521
- - KMF
522
- - KPW
523
- - KRW
524
- - KWD
525
- - KYD
526
- - KZT
527
- - LAK
528
- - LBP
529
- - LKR
530
- - LRD
531
- - LSL
532
- - LYD
533
- - MAD
534
- - MDL
535
- - MGA
536
- - MKD
537
- - MMK
538
- - MNT
539
- - MOP
540
- - MRO
541
- - MUR
542
- - MVR
543
- - MWK
544
- - MXN
545
- - MYR
546
- - MZN
547
- - NAD
548
- - NGN
549
- - NIO
550
- - NOK
551
- - NPR
552
- - NZD
553
- - OMR
554
- - PAB
555
- - PEN
556
- - PGK
557
- - PHP
558
- - PKR
559
- - PLN
560
- - PYG
561
- - QAR
562
- - RON
563
- - RSD
564
- - RUB
565
- - RWF
566
- - SAR
567
- - SBD
568
- - SCR
569
- - SDG
570
- - SEK
571
- - SGD
572
- - SHP
573
- - SLL
574
- - SOS
575
- - SPL
576
- - SRD
577
- - STD
578
- - SVC
579
- - SYP
580
- - SZL
581
- - THB
582
- - TJS
583
- - TMT
584
- - TND
585
- - TOP
586
- - TRY
587
- - TTD
588
- - TVD
589
- - TWD
590
- - TZS
591
- - UAH
592
- - UGX
593
- - USD
594
- - UYU
595
- - UZS
596
- - VEF
597
- - VND
598
- - VUV
599
- - WST
600
- - XAF
601
- - XCD
602
- - XDR
603
- - XOF
604
- - XPF
605
- - XTS
606
- - XXX
607
- - YER
608
- - ZAR
609
- - ZMW
610
- - ZWD
611
- feesAmount:
612
- description: >-
613
- The fees in the transaction. The fees element should be
614
- empty if fees should be non-disclosed. The fees element
615
- should be non-empty if fees should be disclosed.
616
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
617
- type: string
618
- feesCurrency:
619
- maxLength: 3
620
- minLength: 3
621
- type: string
622
- enum: *ref_10
623
- transactionType:
624
- description: Type of transaction for which the quote is requested.
625
- type: string
626
- enum: &ref_17
627
- - TRANSFER
628
- initiator:
629
- description: >-
630
- Specifies if the initiator of the transfer is the Payer or
631
- Payee.
632
- type: string
633
- enum: &ref_18
634
- - PAYER
635
- - PAYEE
636
- initiatorType:
637
- description: Specifies the type of the transaction initiator.
638
- type: string
639
- enum: &ref_19
640
- - CONSUMER
641
- - AGENT
642
- - BUSINESS
643
- - DEVICE
644
- geoCode:
645
- description: >-
646
- Indicates the geographic location from where the transaction
647
- was initiated.
648
- type: object
649
- properties: &ref_12
650
- latitude:
651
- type: string
652
- pattern: >-
653
- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
654
- description: >-
655
- The API data type Latitude is a JSON String in a lexical
656
- format that is restricted by a regular expression for
657
- interoperability reasons.
658
- longitude:
659
- type: string
660
- pattern: >-
661
- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
662
- description: >-
663
- The API data type Longitude is a JSON String in a
664
- lexical format that is restricted by a regular
665
- expression for interoperability reasons.
666
- required: &ref_13
667
- - latitude
668
- - longitude
669
- note:
670
- type: string
671
- minLength: 1
672
- maxLength: 128
673
- description: An optional note associated with the requested transfer.
674
- expiration:
675
- description: An ISO-8601 formatted timestamp.
676
- type: string
677
- pattern: >-
678
- ^(?:[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)$
679
- extensionList:
680
- type: array
681
- items: *ref_11
682
- minItems: 0
683
- maxItems: 16
684
- responses:
685
- '200':
686
- description: A response to the transfer quotation request
687
- content:
688
- application/json:
689
- schema:
690
- type: object
691
- description: A response to a request for a quote.
692
- required: &ref_14
693
- - quoteId
694
- - transactionId
695
- - transferAmount
696
- - transferAmountCurrency
697
- properties: &ref_15
698
- quoteId:
699
- description: A Mojaloop API quote identifier (UUID).
700
- pattern: >-
701
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
702
- type: string
703
- transactionId:
704
- description: >-
705
- ID of the transaction, the ID is decided by the Payer FSP
706
- during the creation of the quote.
707
- pattern: >-
708
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
709
- type: string
710
- transferAmount:
711
- description: >-
712
- The amount of money that the Payer FSP should transfer to
713
- the Payee FSP.
714
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
715
- type: string
716
- transferAmountCurrency:
717
- description: The currency of the `transferAmount`.
718
- maxLength: 3
719
- minLength: 3
720
- type: string
721
- enum: *ref_10
722
- payeeReceiveAmount:
723
- description: >-
724
- The amount that the Payee should receive in the end-to-end
725
- transaction. Optional as the Payee FSP might not want to
726
- disclose any optional Payee fees.
727
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
728
- type: string
729
- payeeReceiveAmountCurrency:
730
- description: The currency of the `payeeReceiveAmount`.
731
- maxLength: 3
732
- minLength: 3
733
- type: string
734
- enum: *ref_10
735
- payeeFspFeeAmount:
736
- description: Payee FSP’s part of the transaction fee.
737
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
738
- type: string
739
- payeeFspFeeAmountCurrency:
740
- description: The currency of the `payeeFspFeeAmount`.
741
- maxLength: 3
742
- minLength: 3
743
- type: string
744
- enum: *ref_10
745
- payeeFspCommissionAmount:
746
- description: Transaction commission from the Payee FSP.
747
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
748
- type: string
749
- payeeFspCommissionAmountCurrency:
750
- description: Currency of the `payeeFspCommissionAmount`.
751
- maxLength: 3
752
- minLength: 3
753
- type: string
754
- enum: *ref_10
755
- expiration:
756
- description: An ISO-8601 formatted timestamp.
757
- type: string
758
- pattern: >-
759
- ^(?:[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)$
760
- geoCode:
761
- description: >-
762
- Indicates the geographic location from where the
763
- transaction was initiated.
764
- type: object
765
- properties: *ref_12
766
- required: *ref_13
767
- extensionList:
768
- type: array
769
- items: *ref_11
770
- minItems: 0
771
- maxItems: 16
772
- '400':
773
- description: Malformed or missing required headers or parameters
774
- content: *ref_5
775
- '500':
776
- description: An error occurred processing the request
777
- content: *ref_6
778
- /transfers:
779
- post:
780
- summary: Transfers funds from an external account to an internal account
781
- description: >-
782
- The HTTP request `POST /transfers` is used to request the creation of a
783
- transfer for the transfer party.
784
- tags:
785
- - Transfers
786
- requestBody:
787
- description: An incoming transfer request
788
- content:
789
- application/json:
790
- schema:
791
- type: object
792
- required: &ref_39
793
- - transferId
794
- - quote
795
- - from
796
- - to
797
- - amountType
798
- - currency
799
- - amount
800
- - transactionType
801
- - ilpPacket
802
- properties: &ref_40
803
- transferId:
804
- pattern: >-
805
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
806
- type: string
807
- description: A Mojaloop API transfer identifier (UUID).
808
- quote:
809
- type: object
810
- description: A response to a request for a quote.
811
- required: *ref_14
812
- properties: *ref_15
813
- quoteRequestExtensions:
814
- type: array
815
- items: *ref_11
816
- minItems: 0
817
- maxItems: 16
818
- from:
819
- type: object
820
- required: *ref_8
821
- properties: *ref_9
822
- to:
823
- type: object
824
- required: *ref_8
825
- properties: *ref_9
826
- amountType:
827
- type: string
828
- enum: *ref_16
829
- description: SEND for send amount, RECEIVE for receive amount.
830
- currency:
831
- maxLength: 3
832
- minLength: 3
833
- type: string
834
- enum: *ref_10
835
- amount:
836
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
837
- type: string
838
- transactionType:
839
- type: string
840
- enum: *ref_17
841
- ilpPacket:
842
- type: object
843
- required:
844
- - data
845
- properties:
846
- data:
847
- type: object
848
- description: Object containing transfer object.
849
- required: &ref_37
850
- - quoteId
851
- - transactionId
852
- - payer
853
- - payee
854
- - amount
855
- - transactionType
856
- properties: &ref_38
857
- quoteId:
858
- pattern: >-
859
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
860
- type: string
861
- description: A Mojaloop API quote identifier (UUID).
862
- transactionId:
863
- description: >-
864
- ID of the transaction, the ID is decided by the
865
- Payer FSP during the creation of the quote.
866
- pattern: >-
867
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
868
- type: string
869
- payer:
870
- description: >-
871
- Information about the Payer in the proposed
872
- financial transaction.
873
- type: object
874
- required: *ref_8
875
- properties: *ref_9
876
- payee:
877
- description: >-
878
- Information about the Payee in the proposed
879
- financial transaction.
880
- type: object
881
- required: *ref_8
882
- properties: *ref_9
883
- amount:
884
- description: >-
885
- Object containing Amount and Currency of the
886
- transfer.
887
- type: object
888
- required: &ref_33
889
- - amount
890
- - currency
891
- properties: &ref_34
892
- amount:
893
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
894
- type: string
895
- currency:
896
- maxLength: 3
897
- minLength: 3
898
- type: string
899
- enum: *ref_10
900
- transactionType:
901
- description: Object containing transfer object.
902
- type: object
903
- required: &ref_35
904
- - scenario
905
- - initiator
906
- - initiatorType
907
- properties: &ref_36
908
- scenario:
909
- type: string
910
- enum: &ref_32
911
- - TRANSFER
912
- initiator:
913
- type: string
914
- enum: *ref_18
915
- description: >-
916
- Specifies if the initiator of the transfer is
917
- the Payer or Payee.
918
- initiatorType:
919
- description: Specifies the type of the transaction initiator.
920
- type: string
921
- enum: *ref_19
922
- note:
923
- maxLength: 128
924
- type: string
925
- responses:
926
- '200':
927
- description: The transfer was accepted
928
- content:
929
- application/json:
930
- schema:
931
- type: object
932
- required: &ref_41
933
- - homeTransactionId
934
- properties: &ref_42
935
- homeTransactionId:
936
- type: string
937
- description: >-
938
- Transaction ID from the DFSP backend, used to reconcile
939
- transactions between the Switch and DFSP backend systems.
940
- fulfilment:
941
- description: >-
942
- Fulfilment that must be attached to the transfer by the
943
- Payee.
944
- title: IlpFulfilment
945
- type: string
946
- pattern: ^[A-Za-z0-9-_]{43}$
947
- maxLength: 48
948
- example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
949
- transferState:
950
- description: >
951
- Below are the allowed values for the enumeration -
952
- RECEIVED DFSP has received the transfer. - RESERVED DFSP
953
- has reserved the transfer. - COMMITTED DFSP has
954
- successfully performed the transfer. - ABORTED DFSP has
955
- aborted the transfer due a rejection or failure to perform
956
- the transfer.
957
- example: ABORTED
958
- type: string
959
- enum: &ref_20
960
- - RECEIVED
961
- - RESERVED
962
- - COMMITTED
963
- - ABORTED
964
- completedTimestamp:
965
- description: An ISO-8601 formatted timestamp.
966
- example: '2020-05-19T08:38:08.699-04:00'
967
- type: string
968
- pattern: >-
969
- ^(?:[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)$
970
- '400':
971
- description: Malformed or missing required headers or parameters
972
- content: *ref_5
973
- '500':
974
- description: An error occurred processing the request
975
- content: *ref_6
976
- /transfers/{transferId}:
977
- parameters:
978
- - name: transferId
979
- in: path
980
- required: true
981
- schema: &ref_80
982
- type: string
983
- get:
984
- summary: Retrieves information for a specific transfer
985
- description: >-
986
- The HTTP request `GET /transfers/{transferId}` is used to get
987
- information regarding a transfer created or requested earlier. The
988
- `{transferId}` in the URI should contain the `transferId` that was used
989
- for the creation of the transfer.
990
- tags:
991
- - Transfers
992
- responses:
993
- '200':
994
- description: The transfer was accepted
995
- content:
996
- application/json:
997
- schema:
998
- type: object
999
- required: &ref_43
1000
- - homeTransactionId
1001
- - from
1002
- - to
1003
- - amountType
1004
- - currency
1005
- - amount
1006
- - transferState
1007
- - transactionType
1008
- - timestamp
1009
- properties: &ref_44
1010
- homeTransactionId:
1011
- type: string
1012
- description: >-
1013
- Transaction ID from the DFSP backend, used to reconcile
1014
- transactions between the Switch and DFSP backend systems.
1015
- from:
1016
- type: object
1017
- required: *ref_8
1018
- properties: *ref_9
1019
- to:
1020
- type: object
1021
- required: *ref_8
1022
- properties: *ref_9
1023
- amountType:
1024
- type: string
1025
- enum: *ref_16
1026
- description: SEND for send amount, RECEIVE for receive amount.
1027
- currency:
1028
- maxLength: 3
1029
- minLength: 3
1030
- type: string
1031
- enum: *ref_10
1032
- amount:
1033
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1034
- type: string
1035
- transferState:
1036
- type: string
1037
- enum: *ref_20
1038
- description: >
1039
- Below are the allowed values for the enumeration -
1040
- RECEIVED DFSP has received the transfer. - RESERVED DFSP
1041
- has reserved the transfer. - COMMITTED DFSP has
1042
- successfully performed the transfer. - ABORTED DFSP has
1043
- aborted the transfer due a rejection or failure to perform
1044
- the transfer.
1045
- timestamp:
1046
- type: string
1047
- pattern: >-
1048
- ^(?:[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)$
1049
- description: An ISO-8601 formatted timestamp.
1050
- transactionType:
1051
- type: string
1052
- enum: *ref_17
1053
- note:
1054
- maxLength: 128
1055
- type: string
1056
- extensions:
1057
- type: array
1058
- items: *ref_11
1059
- minItems: 0
1060
- maxItems: 16
1061
- '500':
1062
- description: An error occurred processing the request
1063
- content: *ref_6
1064
- put:
1065
- summary: Receive notification for a specific transfer
1066
- description: >-
1067
- The HTTP request `PUT /transfers/{transferId}` is used to receive
1068
- notification for transfer being fulfiled when the FSP is a Payee
1069
- tags:
1070
- - Transfers
1071
- requestBody:
1072
- description: An incoming notification for fulfiled transfer
1073
- content:
1074
- application/json:
1075
- schema:
1076
- title: TransfersIDPatchResponse
1077
- type: object
1078
- description: PUT /transfers/{transferId} object
1079
- properties: &ref_46
1080
- transferId:
1081
- pattern: >-
1082
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1083
- type: string
1084
- description: A Mojaloop API transfer identifier (UUID).
1085
- direction:
1086
- type: string
1087
- enum:
1088
- - INBOUND
1089
- quoteRequest:
1090
- type: object
1091
- properties:
1092
- headers:
1093
- type: object
1094
- body:
1095
- type: object
1096
- quoteResponse:
1097
- type: object
1098
- properties:
1099
- headers:
1100
- type: object
1101
- body:
1102
- type: object
1103
- prepare:
1104
- type: object
1105
- properties:
1106
- headers:
1107
- type: object
1108
- body:
1109
- type: object
1110
- fulfil:
1111
- type: object
1112
- properties:
1113
- headers:
1114
- type: object
1115
- body:
1116
- type: object
1117
- quote:
1118
- type: object
1119
- properties:
1120
- request:
1121
- type: object
1122
- internalRequest:
1123
- type: object
1124
- response:
1125
- type: object
1126
- mojaloopResponse:
1127
- type: object
1128
- fulfilment:
1129
- type: string
1130
- currentState:
1131
- type: string
1132
- enum: &ref_45
1133
- - ERROR_OCCURRED
1134
- - WAITING_FOR_PARTY_ACCEPTANCE
1135
- - WAITING_FOR_QUOTE_ACCEPTANCE
1136
- - COMPLETED
1137
- lastError:
1138
- type: object
1139
- description: >-
1140
- This object represents a Mojaloop API error received at any
1141
- time during the transfer process
1142
- properties: &ref_26
1143
- httpStatusCode:
1144
- type: integer
1145
- description: >-
1146
- The HTTP status code returned to the caller. This is the
1147
- same as the actual HTTP status code returned with the
1148
- response.
1149
- mojaloopError:
1150
- description: >-
1151
- If a transfer process results in an error callback
1152
- during the asynchronous Mojaloop API exchange, this
1153
- property will contain the underlying Mojaloop API error
1154
- object.
1155
- type: object
1156
- properties: &ref_51
1157
- errorInformation:
1158
- title: ErrorInformation
1159
- type: object
1160
- description: Data model for the complex type ErrorInformation.
1161
- properties: &ref_49
1162
- errorCode:
1163
- title: ErrorCode
1164
- type: string
1165
- pattern: ^[1-9]\d{3}$
1166
- description: >-
1167
- The API data type ErrorCode is a JSON String of
1168
- four characters, consisting of digits only.
1169
- Negative numbers are not allowed. A leading zero
1170
- is not allowed. Each error code in the API is a
1171
- four-digit number, for example, 1234, where the
1172
- first number (1 in the example) represents the
1173
- high-level error category, the second number (2
1174
- in the example) represents the low-level error
1175
- category, and the last two numbers (34 in the
1176
- example) represent the specific error.
1177
- example: '5100'
1178
- errorDescription:
1179
- title: ErrorDescription
1180
- type: string
1181
- minLength: 1
1182
- maxLength: 128
1183
- description: Error description string.
1184
- extensionList:
1185
- title: ExtensionList
1186
- type: object
1187
- description: >-
1188
- Data model for the complex type ExtensionList.
1189
- An optional list of extensions, specific to
1190
- deployment.
1191
- properties: &ref_21
1192
- extension:
1193
- type: array
1194
- items:
1195
- title: Extension
1196
- type: object
1197
- description: Data model for the complex type Extension.
1198
- properties: &ref_47
1199
- key:
1200
- title: ExtensionKey
1201
- type: string
1202
- minLength: 1
1203
- maxLength: 32
1204
- description: Extension key.
1205
- value:
1206
- title: ExtensionValue
1207
- type: string
1208
- minLength: 1
1209
- maxLength: 128
1210
- description: Extension value.
1211
- required: &ref_48
1212
- - key
1213
- - value
1214
- minItems: 1
1215
- maxItems: 16
1216
- description: Number of Extension elements.
1217
- required: &ref_22
1218
- - extension
1219
- required: &ref_50
1220
- - errorCode
1221
- - errorDescription
1222
- initiatedTimestamp:
1223
- type: string
1224
- pattern: >-
1225
- ^(?:[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)$
1226
- description: An ISO-8601 formatted timestamp.
1227
- finalNotification:
1228
- type: object
1229
- properties:
1230
- completedTimestamp:
1231
- description: An ISO-8601 formatted timestamp.
1232
- example: '2020-05-19T08:38:08.699-04:00'
1233
- type: string
1234
- pattern: >-
1235
- ^(?:[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)$
1236
- transferState:
1237
- description: >
1238
- Below are the allowed values for the enumeration -
1239
- RECEIVED DFSP has received the transfer. - RESERVED DFSP
1240
- has reserved the transfer. - COMMITTED DFSP has
1241
- successfully performed the transfer. - ABORTED DFSP has
1242
- aborted the transfer due a rejection or failure to
1243
- perform the transfer.
1244
- example: COMMITTED
1245
- type: string
1246
- enum: *ref_20
1247
- extensionList:
1248
- description: Optional extension, specific to deployment.
1249
- type: array
1250
- items: *ref_11
1251
- minItems: 0
1252
- maxItems: 16
1253
- required:
1254
- - completedTimestamp
1255
- - transferState
1256
- responses:
1257
- '200':
1258
- description: The notification was accepted
1259
- '500':
1260
- description: An error occurred processing the request
1261
- content: *ref_6
1262
- /bulkTransactions/{bulkTransactionId}:
1263
- parameters:
1264
- - name: bulkTransactionId
1265
- in: path
1266
- required: true
1267
- schema: &ref_81
1268
- title: CorrelationId
1269
- type: string
1270
- pattern: >-
1271
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1272
- description: >-
1273
- Identifier that correlates all messages of the same sequence. The
1274
- API data type UUID (Universally Unique Identifier) is a JSON String
1275
- in canonical format, conforming to [RFC
1276
- 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
1277
- regular expression for interoperability reasons. A UUID is always 36
1278
- characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
1279
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1280
- description: >-
1281
- Identifier of the bulk transaction to continue as returned in the
1282
- response to a `POST /bulkTransaction` request.
1283
- put:
1284
- summary: Request is used for bulk transaction confirmations
1285
- description: >-
1286
- The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to
1287
- request information regarding a bulk transaction, i.e. when
1288
- autoAcceptParty or autoAcceptQuote is false then the payer need to
1289
- provide confirmation to proceed with further processing of the request.
1290
- The `{bulkTransactionId}` in the URI should contain the
1291
- `bulkTransactionId` that was used for the creation of the bulk transfer.
1292
- tags:
1293
- - BulkTransactions
1294
- requestBody:
1295
- description: An incoming notification for fulfiled transfer
1296
- content:
1297
- application/json:
1298
- schema:
1299
- title: BulkTransactionResponse
1300
- type: object
1301
- required: &ref_78
1302
- - bulkHomeTransactionID
1303
- - bulkTransactionId
1304
- - currentState
1305
- - individualTransferResults
1306
- properties: &ref_79
1307
- bulkHomeTransactionID:
1308
- type: string
1309
- description: >-
1310
- Transaction ID from the DFSP backend, used to reconcile
1311
- transactions between the Switch and DFSP backend systems.
1312
- bulkTransactionId:
1313
- title: CorrelationId
1314
- type: string
1315
- pattern: >-
1316
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1317
- description: >-
1318
- Identifier that correlates all messages of the same
1319
- sequence. The API data type UUID (Universally Unique
1320
- Identifier) is a JSON String in canonical format, conforming
1321
- to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
1322
- restricted by a regular expression for interoperability
1323
- reasons. A UUID is always 36 characters long, 32 hexadecimal
1324
- symbols and 4 dashes (‘-‘).
1325
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1326
- currentState:
1327
- type: string
1328
- enum: &ref_52
1329
- - ERROR_OCCURRED
1330
- - WAITING_FOR_PARTY_ACCEPTANCE
1331
- - WAITING_FOR_QUOTE_ACCEPTANCE
1332
- - COMPLETED
1333
- options:
1334
- type: object
1335
- required: &ref_59
1336
- - autoAcceptParty
1337
- - autoAcceptQuote
1338
- - bulkExpiration
1339
- properties: &ref_60
1340
- onlyValidateParty:
1341
- description: >-
1342
- Set to true if only party validation is required. This
1343
- means the quotes and transfers will not run. This is
1344
- useful for only party resolution.
1345
- type: boolean
1346
- autoAcceptParty:
1347
- type: object
1348
- required: &ref_53
1349
- - enabled
1350
- properties: &ref_54
1351
- enabled:
1352
- type: boolean
1353
- enum:
1354
- - false
1355
- - true
1356
- autoAcceptQuote:
1357
- description: >-
1358
- Set to true if the quote response is accepted without
1359
- confirmation from the payer. The fees applied by the
1360
- payee will be acceptable to the payer abiding by the
1361
- limits set by optional 'perTransferFeeLimits' array.
1362
- type: object
1363
- oneOf:
1364
- - type: object
1365
- required: &ref_57
1366
- - enabled
1367
- properties: &ref_58
1368
- enabled:
1369
- type: boolean
1370
- enum:
1371
- - true
1372
- - false
1373
- perTransferFeeLimits:
1374
- type: array
1375
- minItems: 0
1376
- items:
1377
- type: object
1378
- required: &ref_55
1379
- - currency
1380
- - amount
1381
- properties: &ref_56
1382
- currency:
1383
- title: Currency
1384
- description: >-
1385
- The currency codes defined in [ISO
1386
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
1387
- as three-letter alphabetic codes are used
1388
- as the standard naming representation for
1389
- currencies.
1390
- type: string
1391
- minLength: 3
1392
- maxLength: 3
1393
- enum: &ref_23
1394
- - AED
1395
- - AFN
1396
- - ALL
1397
- - AMD
1398
- - ANG
1399
- - AOA
1400
- - ARS
1401
- - AUD
1402
- - AWG
1403
- - AZN
1404
- - BAM
1405
- - BBD
1406
- - BDT
1407
- - BGN
1408
- - BHD
1409
- - BIF
1410
- - BMD
1411
- - BND
1412
- - BOB
1413
- - BRL
1414
- - BSD
1415
- - BTN
1416
- - BWP
1417
- - BYN
1418
- - BZD
1419
- - CAD
1420
- - CDF
1421
- - CHF
1422
- - CLP
1423
- - CNY
1424
- - COP
1425
- - CRC
1426
- - CUC
1427
- - CUP
1428
- - CVE
1429
- - CZK
1430
- - DJF
1431
- - DKK
1432
- - DOP
1433
- - DZD
1434
- - EGP
1435
- - ERN
1436
- - ETB
1437
- - EUR
1438
- - FJD
1439
- - FKP
1440
- - GBP
1441
- - GEL
1442
- - GGP
1443
- - GHS
1444
- - GIP
1445
- - GMD
1446
- - GNF
1447
- - GTQ
1448
- - GYD
1449
- - HKD
1450
- - HNL
1451
- - HRK
1452
- - HTG
1453
- - HUF
1454
- - IDR
1455
- - ILS
1456
- - IMP
1457
- - INR
1458
- - IQD
1459
- - IRR
1460
- - ISK
1461
- - JEP
1462
- - JMD
1463
- - JOD
1464
- - JPY
1465
- - KES
1466
- - KGS
1467
- - KHR
1468
- - KMF
1469
- - KPW
1470
- - KRW
1471
- - KWD
1472
- - KYD
1473
- - KZT
1474
- - LAK
1475
- - LBP
1476
- - LKR
1477
- - LRD
1478
- - LSL
1479
- - LYD
1480
- - MAD
1481
- - MDL
1482
- - MGA
1483
- - MKD
1484
- - MMK
1485
- - MNT
1486
- - MOP
1487
- - MRO
1488
- - MUR
1489
- - MVR
1490
- - MWK
1491
- - MXN
1492
- - MYR
1493
- - MZN
1494
- - NAD
1495
- - NGN
1496
- - NIO
1497
- - NOK
1498
- - NPR
1499
- - NZD
1500
- - OMR
1501
- - PAB
1502
- - PEN
1503
- - PGK
1504
- - PHP
1505
- - PKR
1506
- - PLN
1507
- - PYG
1508
- - QAR
1509
- - RON
1510
- - RSD
1511
- - RUB
1512
- - RWF
1513
- - SAR
1514
- - SBD
1515
- - SCR
1516
- - SDG
1517
- - SEK
1518
- - SGD
1519
- - SHP
1520
- - SLL
1521
- - SOS
1522
- - SPL
1523
- - SRD
1524
- - STD
1525
- - SVC
1526
- - SYP
1527
- - SZL
1528
- - THB
1529
- - TJS
1530
- - TMT
1531
- - TND
1532
- - TOP
1533
- - TRY
1534
- - TTD
1535
- - TVD
1536
- - TWD
1537
- - TZS
1538
- - UAH
1539
- - UGX
1540
- - USD
1541
- - UYU
1542
- - UZS
1543
- - VEF
1544
- - VND
1545
- - VUV
1546
- - WST
1547
- - XAF
1548
- - XCD
1549
- - XDR
1550
- - XOF
1551
- - XPF
1552
- - XTS
1553
- - XXX
1554
- - YER
1555
- - ZAR
1556
- - ZMW
1557
- - ZWD
1558
- amount:
1559
- title: Amount
1560
- type: string
1561
- pattern: >-
1562
- ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1563
- description: >-
1564
- The API data type Amount is a JSON String
1565
- in a canonical format that is restricted
1566
- by a regular expression for
1567
- interoperability reasons. This pattern
1568
- does not allow any trailing zeroes at all,
1569
- but allows an amount without a minor
1570
- currency unit. It also only allows four
1571
- digits in the minor currency unit; a
1572
- negative value is not allowed. Using more
1573
- than 18 digits in the major currency unit
1574
- is not allowed.
1575
- example: '123.45'
1576
- skipPartyLookup:
1577
- description: >-
1578
- Set to true if supplying an FSPID for the payee party
1579
- and no party resolution is needed. This may be useful if
1580
- a previous party resolution has been performed.
1581
- type: boolean
1582
- synchronous:
1583
- description: >-
1584
- Set to true if the bulkTransfer requests need be handled
1585
- synchronous. Otherwise the requests will be handled
1586
- asynchronously, meaning there will be callbacks
1587
- whenever the processing is done
1588
- type: boolean
1589
- bulkExpiration:
1590
- title: DateTime
1591
- type: string
1592
- pattern: >-
1593
- ^(?:[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)$
1594
- description: >-
1595
- The API data type DateTime is a JSON String in a lexical
1596
- format that is restricted by a regular expression for
1597
- interoperability reasons. The format is according to
1598
- [ISO
1599
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
1600
- expressed in a combined date, time and time zone format.
1601
- A more readable version of the format is
1602
- yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
1603
- "2016-05-24T08:38:08.699-04:00",
1604
- "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time
1605
- zone, same as UTC).
1606
- example: '2016-05-24T08:38:08.699-04:00'
1607
- individualTransferResults:
1608
- description: >-
1609
- List of individual transfer result in a bulk transfer
1610
- response.
1611
- type: array
1612
- minItems: 1
1613
- items:
1614
- type: object
1615
- required: &ref_76
1616
- - homeTransactionId
1617
- - transferId
1618
- - to
1619
- - amountType
1620
- - currency
1621
- - amount
1622
- properties: &ref_77
1623
- transferId:
1624
- title: CorrelationId
1625
- type: string
1626
- pattern: >-
1627
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1628
- description: >-
1629
- Identifier that correlates all messages of the same
1630
- sequence. The API data type UUID (Universally Unique
1631
- Identifier) is a JSON String in canonical format,
1632
- conforming to [RFC
1633
- 4122](https://tools.ietf.org/html/rfc4122), that is
1634
- restricted by a regular expression for
1635
- interoperability reasons. A UUID is always 36
1636
- characters long, 32 hexadecimal symbols and 4 dashes
1637
- (‘-‘).
1638
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1639
- homeTransactionId:
1640
- type: string
1641
- description: >-
1642
- Transaction ID from the DFSP backend, used to
1643
- reconcile transactions between the Switch and DFSP
1644
- backend systems.
1645
- transactionId:
1646
- title: CorrelationId
1647
- type: string
1648
- pattern: >-
1649
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1650
- description: >-
1651
- Identifier that correlates all messages of the same
1652
- sequence. The API data type UUID (Universally Unique
1653
- Identifier) is a JSON String in canonical format,
1654
- conforming to [RFC
1655
- 4122](https://tools.ietf.org/html/rfc4122), that is
1656
- restricted by a regular expression for
1657
- interoperability reasons. A UUID is always 36
1658
- characters long, 32 hexadecimal symbols and 4 dashes
1659
- (‘-‘).
1660
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1661
- to:
1662
- title: Party
1663
- type: object
1664
- description: Data model for the complex type Party.
1665
- properties: &ref_66
1666
- partyIdInfo:
1667
- title: PartyIdInfo
1668
- type: object
1669
- description: >-
1670
- Data model for the complex type PartyIdInfo. An
1671
- ExtensionList element has been added to this
1672
- reqeust in version v1.1
1673
- properties: &ref_62
1674
- partyIdType:
1675
- title: PartyIdType
1676
- type: string
1677
- enum: &ref_61
1678
- - MSISDN
1679
- - EMAIL
1680
- - PERSONAL_ID
1681
- - BUSINESS
1682
- - DEVICE
1683
- - ACCOUNT_ID
1684
- - IBAN
1685
- - ALIAS
1686
- description: >-
1687
- Below are the allowed values for the
1688
- enumeration.
1689
-
1690
- - MSISDN - An MSISDN (Mobile Station
1691
- International Subscriber Directory Number,
1692
- that is, the phone number) is used as
1693
- reference to a participant. The MSISDN
1694
- identifier should be in international format
1695
- according to the [ITU-T E.164
1696
- standard](https://www.itu.int/rec/T-REC-E.164/en).
1697
- Optionally, the MSISDN may be prefixed by a
1698
- single plus sign, indicating the international
1699
- prefix.
1700
-
1701
- - EMAIL - An email is used as reference to a
1702
- participant. The format of the email should be
1703
- according to the informational [RFC
1704
- 3696](https://tools.ietf.org/html/rfc3696).
1705
-
1706
- - PERSONAL_ID - A personal identifier is used
1707
- as reference to a participant. Examples of
1708
- personal identification are passport number,
1709
- birth certificate number, and national
1710
- registration number. The identifier number is
1711
- added in the PartyIdentifier element. The
1712
- personal identifier type is added in the
1713
- PartySubIdOrType element.
1714
-
1715
- - BUSINESS - A specific Business (for example,
1716
- an organization or a company) is used as
1717
- reference to a participant. The BUSINESS
1718
- identifier can be in any format. To make a
1719
- transaction connected to a specific username
1720
- or bill number in a Business, the
1721
- PartySubIdOrType element should be used.
1722
-
1723
- - DEVICE - A specific device (for example, a
1724
- POS or ATM) ID connected to a specific
1725
- business or organization is used as reference
1726
- to a Party. For referencing a specific device
1727
- under a specific business or organization, use
1728
- the PartySubIdOrType element.
1729
-
1730
- - ACCOUNT_ID - A bank account number or FSP
1731
- account ID should be used as reference to a
1732
- participant. The ACCOUNT_ID identifier can be
1733
- in any format, as formats can greatly differ
1734
- depending on country and FSP.
1735
-
1736
- - IBAN - A bank account number or FSP account
1737
- ID is used as reference to a participant. The
1738
- IBAN identifier can consist of up to 34
1739
- alphanumeric characters and should be entered
1740
- without whitespace.
1741
-
1742
- - ALIAS An alias is used as reference to a
1743
- participant. The alias should be created in
1744
- the FSP as an alternative reference to an
1745
- account owner. Another example of an alias is
1746
- a username in the FSP system. The ALIAS
1747
- identifier can be in any format. It is also
1748
- possible to use the PartySubIdOrType element
1749
- for identifying an account under an Alias
1750
- defined by the PartyIdentifier.
1751
- partyIdentifier:
1752
- title: PartyIdentifier
1753
- type: string
1754
- minLength: 1
1755
- maxLength: 128
1756
- description: Identifier of the Party.
1757
- example: '16135551212'
1758
- partySubIdOrType:
1759
- title: PartySubIdOrType
1760
- type: string
1761
- minLength: 1
1762
- maxLength: 128
1763
- description: >-
1764
- Either a sub-identifier of a PartyIdentifier,
1765
- or a sub-type of the PartyIdType, normally a
1766
- PersonalIdentifierType.
1767
- fspId:
1768
- title: FspId
1769
- type: string
1770
- minLength: 1
1771
- maxLength: 32
1772
- description: FSP identifier.
1773
- extensionList:
1774
- title: ExtensionList
1775
- type: object
1776
- description: >-
1777
- Data model for the complex type ExtensionList.
1778
- An optional list of extensions, specific to
1779
- deployment.
1780
- properties: *ref_21
1781
- required: *ref_22
1782
- required: &ref_63
1783
- - partyIdType
1784
- - partyIdentifier
1785
- merchantClassificationCode:
1786
- title: MerchantClassificationCode
1787
- type: string
1788
- pattern: ^[\d]{1,4}$
1789
- description: >-
1790
- A limited set of pre-defined numbers. This list
1791
- would be a limited set of numbers identifying a
1792
- set of popular merchant types like School Fees,
1793
- Pubs and Restaurants, Groceries, etc.
1794
- name:
1795
- title: PartyName
1796
- type: string
1797
- minLength: 1
1798
- maxLength: 128
1799
- description: >-
1800
- Name of the Party. Could be a real name or a
1801
- nickname.
1802
- personalInfo:
1803
- title: PartyPersonalInfo
1804
- type: object
1805
- description: Data model for the complex type PartyPersonalInfo.
1806
- properties: &ref_65
1807
- complexName:
1808
- title: PartyComplexName
1809
- type: object
1810
- description: >-
1811
- Data model for the complex type
1812
- PartyComplexName.
1813
- properties: &ref_64
1814
- firstName:
1815
- title: FirstName
1816
- type: string
1817
- minLength: 1
1818
- maxLength: 128
1819
- pattern: >-
1820
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1821
- .,''-]{1,128}$
1822
- description: First name of the Party (Name Type).
1823
- example: Henrik
1824
- middleName:
1825
- title: MiddleName
1826
- type: string
1827
- minLength: 1
1828
- maxLength: 128
1829
- pattern: >-
1830
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1831
- .,''-]{1,128}$
1832
- description: Middle name of the Party (Name Type).
1833
- example: Johannes
1834
- lastName:
1835
- title: LastName
1836
- type: string
1837
- minLength: 1
1838
- maxLength: 128
1839
- pattern: >-
1840
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1841
- .,''-]{1,128}$
1842
- description: Last name of the Party (Name Type).
1843
- example: Karlsson
1844
- dateOfBirth:
1845
- title: DateofBirth (type Date)
1846
- type: string
1847
- pattern: >-
1848
- ^(?:[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)$
1849
- description: Date of Birth of the Party.
1850
- example: '1966-06-16'
1851
- required: &ref_67
1852
- - partyIdInfo
1853
- reference:
1854
- description: Payer Loan reference
1855
- type: string
1856
- amountType:
1857
- title: AmountType
1858
- type: string
1859
- enum: &ref_68
1860
- - SEND
1861
- - RECEIVE
1862
- description: >-
1863
- Below are the allowed values for the enumeration
1864
- AmountType.
1865
-
1866
- - SEND - Amount the Payer would like to send, that is,
1867
- the amount that should be withdrawn from the Payer
1868
- account including any fees.
1869
-
1870
- - RECEIVE - Amount the Payer would like the Payee to
1871
- receive, that is, the amount that should be sent to
1872
- the receiver exclusive of any fees.
1873
- example: RECEIVE
1874
- currency:
1875
- title: Currency
1876
- description: >-
1877
- The currency codes defined in [ISO
1878
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
1879
- as three-letter alphabetic codes are used as the
1880
- standard naming representation for currencies.
1881
- type: string
1882
- minLength: 3
1883
- maxLength: 3
1884
- enum: *ref_23
1885
- amount:
1886
- title: Amount
1887
- type: string
1888
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1889
- description: >-
1890
- The API data type Amount is a JSON String in a
1891
- canonical format that is restricted by a regular
1892
- expression for interoperability reasons. This pattern
1893
- does not allow any trailing zeroes at all, but allows
1894
- an amount without a minor currency unit. It also only
1895
- allows four digits in the minor currency unit; a
1896
- negative value is not allowed. Using more than 18
1897
- digits in the major currency unit is not allowed.
1898
- example: '123.45'
1899
- note:
1900
- title: Note
1901
- type: string
1902
- minLength: 1
1903
- maxLength: 128
1904
- description: Memo assigned to transaction.
1905
- example: Note sent to Payee.
1906
- quoteId:
1907
- title: CorrelationId
1908
- type: string
1909
- pattern: >-
1910
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1911
- description: >-
1912
- Identifier that correlates all messages of the same
1913
- sequence. The API data type UUID (Universally Unique
1914
- Identifier) is a JSON String in canonical format,
1915
- conforming to [RFC
1916
- 4122](https://tools.ietf.org/html/rfc4122), that is
1917
- restricted by a regular expression for
1918
- interoperability reasons. A UUID is always 36
1919
- characters long, 32 hexadecimal symbols and 4 dashes
1920
- (‘-‘).
1921
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1922
- quoteResponse:
1923
- title: QuotesIDPutResponse
1924
- type: object
1925
- description: The object sent in the PUT /quotes/{ID} callback.
1926
- properties: &ref_71
1927
- transferAmount:
1928
- title: Money
1929
- type: object
1930
- description: Data model for the complex type Money.
1931
- properties: &ref_24
1932
- currency:
1933
- title: Currency
1934
- description: >-
1935
- The currency codes defined in [ISO
1936
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
1937
- as three-letter alphabetic codes are used as
1938
- the standard naming representation for
1939
- currencies.
1940
- type: string
1941
- minLength: 3
1942
- maxLength: 3
1943
- enum: *ref_23
1944
- amount:
1945
- title: Amount
1946
- type: string
1947
- pattern: >-
1948
- ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1949
- description: >-
1950
- The API data type Amount is a JSON String in a
1951
- canonical format that is restricted by a
1952
- regular expression for interoperability
1953
- reasons. This pattern does not allow any
1954
- trailing zeroes at all, but allows an amount
1955
- without a minor currency unit. It also only
1956
- allows four digits in the minor currency unit;
1957
- a negative value is not allowed. Using more
1958
- than 18 digits in the major currency unit is
1959
- not allowed.
1960
- example: '123.45'
1961
- required: &ref_25
1962
- - currency
1963
- - amount
1964
- payeeReceiveAmount:
1965
- title: Money
1966
- type: object
1967
- description: Data model for the complex type Money.
1968
- properties: *ref_24
1969
- required: *ref_25
1970
- payeeFspFee:
1971
- title: Money
1972
- type: object
1973
- description: Data model for the complex type Money.
1974
- properties: *ref_24
1975
- required: *ref_25
1976
- payeeFspCommission:
1977
- title: Money
1978
- type: object
1979
- description: Data model for the complex type Money.
1980
- properties: *ref_24
1981
- required: *ref_25
1982
- expiration:
1983
- title: DateTime
1984
- type: string
1985
- pattern: >-
1986
- ^(?:[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)$
1987
- description: >-
1988
- The API data type DateTime is a JSON String in a
1989
- lexical format that is restricted by a regular
1990
- expression for interoperability reasons. The
1991
- format is according to [ISO
1992
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
1993
- expressed in a combined date, time and time zone
1994
- format. A more readable version of the format is
1995
- yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
1996
- "2016-05-24T08:38:08.699-04:00",
1997
- "2016-05-24T08:38:08.699Z" (where Z indicates Zulu
1998
- time zone, same as UTC).
1999
- example: '2016-05-24T08:38:08.699-04:00'
2000
- geoCode:
2001
- title: GeoCode
2002
- type: object
2003
- description: >-
2004
- Data model for the complex type GeoCode. Indicates
2005
- the geographic location from where the transaction
2006
- was initiated.
2007
- properties: &ref_69
2008
- latitude:
2009
- title: Latitude
2010
- type: string
2011
- pattern: >-
2012
- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
2013
- description: >-
2014
- The API data type Latitude is a JSON String in
2015
- a lexical format that is restricted by a
2016
- regular expression for interoperability
2017
- reasons.
2018
- example: '+45.4215'
2019
- longitude:
2020
- title: Longitude
2021
- type: string
2022
- pattern: >-
2023
- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
2024
- description: >-
2025
- The API data type Longitude is a JSON String
2026
- in a lexical format that is restricted by a
2027
- regular expression for interoperability
2028
- reasons.
2029
- example: '+75.6972'
2030
- required: &ref_70
2031
- - latitude
2032
- - longitude
2033
- ilpPacket:
2034
- title: IlpPacket
2035
- type: string
2036
- pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
2037
- minLength: 1
2038
- maxLength: 32768
2039
- description: >-
2040
- Information for recipient (transport layer
2041
- information).
2042
- example: >-
2043
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
2044
- condition:
2045
- title: IlpCondition
2046
- type: string
2047
- pattern: ^[A-Za-z0-9-_]{43}$
2048
- maxLength: 48
2049
- description: >-
2050
- Condition that must be attached to the transfer by
2051
- the Payer.
2052
- extensionList:
2053
- title: ExtensionList
2054
- type: object
2055
- description: >-
2056
- Data model for the complex type ExtensionList. An
2057
- optional list of extensions, specific to
2058
- deployment.
2059
- properties: *ref_21
2060
- required: *ref_22
2061
- required: &ref_72
2062
- - transferAmount
2063
- - expiration
2064
- - ilpPacket
2065
- - condition
2066
- fulfil:
2067
- title: TransfersIDPutResponse
2068
- type: object
2069
- description: The object sent in the PUT /transfers/{ID} callback.
2070
- properties: &ref_74
2071
- fulfilment:
2072
- title: IlpFulfilment
2073
- type: string
2074
- pattern: ^[A-Za-z0-9-_]{43}$
2075
- maxLength: 48
2076
- description: >-
2077
- Fulfilment that must be attached to the transfer
2078
- by the Payee.
2079
- example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
2080
- completedTimestamp:
2081
- title: DateTime
2082
- type: string
2083
- pattern: >-
2084
- ^(?:[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)$
2085
- description: >-
2086
- The API data type DateTime is a JSON String in a
2087
- lexical format that is restricted by a regular
2088
- expression for interoperability reasons. The
2089
- format is according to [ISO
2090
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
2091
- expressed in a combined date, time and time zone
2092
- format. A more readable version of the format is
2093
- yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
2094
- "2016-05-24T08:38:08.699-04:00",
2095
- "2016-05-24T08:38:08.699Z" (where Z indicates Zulu
2096
- time zone, same as UTC).
2097
- example: '2016-05-24T08:38:08.699-04:00'
2098
- transferState:
2099
- title: TransferState
2100
- type: string
2101
- enum: &ref_73
2102
- - RECEIVED
2103
- - RESERVED
2104
- - COMMITTED
2105
- - ABORTED
2106
- description: >-
2107
- Below are the allowed values for the enumeration.
2108
-
2109
- - RECEIVED - Next ledger has received the
2110
- transfer.
2111
-
2112
- - RESERVED - Next ledger has reserved the
2113
- transfer.
2114
-
2115
- - COMMITTED - Next ledger has successfully
2116
- performed the transfer.
2117
-
2118
- - ABORTED - Next ledger has aborted the transfer
2119
- due to a rejection or failure to perform the
2120
- transfer.
2121
- example: RESERVED
2122
- extensionList:
2123
- title: ExtensionList
2124
- type: object
2125
- description: >-
2126
- Data model for the complex type ExtensionList. An
2127
- optional list of extensions, specific to
2128
- deployment.
2129
- properties: *ref_21
2130
- required: *ref_22
2131
- required: &ref_75
2132
- - transferState
2133
- quoteExtensions:
2134
- title: ExtensionList
2135
- type: object
2136
- description: >-
2137
- Data model for the complex type ExtensionList. An
2138
- optional list of extensions, specific to deployment.
2139
- properties: *ref_21
2140
- required: *ref_22
2141
- transferExtensions:
2142
- title: ExtensionList
2143
- type: object
2144
- description: >-
2145
- Data model for the complex type ExtensionList. An
2146
- optional list of extensions, specific to deployment.
2147
- properties: *ref_21
2148
- required: *ref_22
2149
- lastError:
2150
- type: object
2151
- description: >-
2152
- This object represents a Mojaloop API error received
2153
- at any time during the transfer process
2154
- properties: *ref_26
2155
- extensions:
2156
- title: ExtensionList
2157
- type: object
2158
- description: >-
2159
- Data model for the complex type ExtensionList. An optional
2160
- list of extensions, specific to deployment.
2161
- properties: *ref_21
2162
- required: *ref_22
2163
- responses:
2164
- '200':
2165
- description: The notification was accepted
2166
- '500':
2167
- description: An error occurred processing the request
2168
- content: *ref_6
2169
- components:
2170
- schemas:
2171
- amountType:
2172
- type: string
2173
- enum: *ref_16
2174
- description: SEND for send amount, RECEIVE for receive amount.
2175
- currency:
2176
- maxLength: 3
2177
- minLength: 3
2178
- type: string
2179
- enum: *ref_10
2180
- dateOfBirth:
2181
- type: string
2182
- pattern: >-
2183
- ^(?:[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)$
2184
- description: Date of birth in the form YYYY-MM-DD.
2185
- errorResponse:
2186
- type: object
2187
- required: *ref_0
2188
- properties: *ref_1
2189
- fspId:
2190
- type: string
2191
- minLength: 1
2192
- maxLength: 32
2193
- description: FSP identifier.
2194
- extensionList:
2195
- type: array
2196
- items: *ref_11
2197
- minItems: 0
2198
- maxItems: 16
2199
- geoCode:
2200
- type: object
2201
- description: >-
2202
- Indicates the geographic location from where the transaction was
2203
- initiated.
2204
- properties: *ref_12
2205
- required: *ref_13
2206
- idType:
2207
- type: string
2208
- enum: *ref_27
2209
- description: >
2210
- Below are the allowed values for the enumeration.
2211
-
2212
-
2213
- - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
2214
- Number, that is, the phone number) is used as reference to a
2215
- participant. The MSISDN identifier should be in international format
2216
- according to the [ITU-T E.164
2217
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
2218
- MSISDN may be prefixed by a single plus sign, indicating the
2219
- international prefix.
2220
-
2221
-
2222
- - ACCOUNT_ID - A bank account number or FSP account ID should be used as
2223
- reference to a participant. The ACCOUNT_ID identifier can be in any
2224
- format, as formats can greatly differ depending on country and FSP.
2225
- personalIdType:
2226
- type: string
2227
- enum:
2228
- - PASSPORT
2229
- - NATIONAL_REGISTRATION
2230
- - DRIVING_LICENSE
2231
- - ALIEN_REGISTRATION
2232
- - NATIONAL_ID_CARD
2233
- - EMPLOYER_ID
2234
- - TAX_ID_NUMBER
2235
- - SENIOR_CITIZENS_CARD
2236
- - MARRIAGE_CERTIFICATE
2237
- - HEALTH_CARD
2238
- - VOTERS_ID
2239
- - UNITED_NATIONS
2240
- - OTHER_ID
2241
- description: >
2242
- Below are the allowed values for the enumeration.
2243
-
2244
-
2245
- - PASSPORT - Apassport number isused in reference to a party.
2246
-
2247
-
2248
- - NATIONAL_REGISTRATION - Anational registration number isused in
2249
- reference to a party.
2250
-
2251
-
2252
- - DRIVING_LICENSE - Adriving license isused in reference to a party.
2253
-
2254
-
2255
- - ALIEN_REGISTRATION - An alien registration number isused in reference
2256
- to a party.
2257
-
2258
-
2259
- - NATIONAL_ID_CARD - Anational ID card number isused in reference to a
2260
- party.
2261
-
2262
-
2263
- - EMPLOYER_ID - Atax identification number isused in reference to a
2264
- party.
2265
-
2266
-
2267
- - TAX_ID_NUMBER - Atax identification number isused in reference to a
2268
- party.
2269
-
2270
-
2271
- - SENIOR_CITIZENS_CARD - Asenior citizens card number isused in
2272
- reference to a party.
2273
-
2274
-
2275
- - MARRIAGE_CERTIFICATE - Amarriage certificate number isused in
2276
- reference to a party.
2277
-
2278
-
2279
- - HEALTH_CARD - Ahealth card number isused in reference to a party.
2280
-
2281
-
2282
- - VOTERS_ID - Avoter’s identification number isused in reference to a
2283
- party.
2284
-
2285
-
2286
- - UNITED_NATIONS - An UN (United Nations) number isused in reference to
2287
- a party.
2288
-
2289
-
2290
- - OTHER_ID - Any other type of identification type number isused in
2291
- reference to a party.
2292
- idValue:
2293
- type: string
2294
- minLength: 1
2295
- maxLength: 128
2296
- description: Identifier of the party.
2297
- idSubValue:
2298
- type: string
2299
- minLength: 1
2300
- maxLength: 128
2301
- description: >-
2302
- Either a sub-identifier of a `{idValue}`, or a sub-type of the
2303
- `{idType}`, normally a `{personalIdType}`
2304
- initiator:
2305
- type: string
2306
- enum: *ref_18
2307
- description: Specifies if the initiator of the transfer is the Payer or Payee.
2308
- extensionItem:
2309
- type: object
2310
- properties: *ref_28
2311
- initiatorType:
2312
- type: string
2313
- enum: *ref_19
2314
- description: Specifies the type of the transaction initiator.
2315
- latitude:
2316
- type: string
2317
- pattern: >-
2318
- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
2319
- description: >-
2320
- The API data type Latitude is a JSON String in a lexical format that is
2321
- restricted by a regular expression for interoperability reasons.
2322
- longitude:
2323
- type: string
2324
- pattern: >-
2325
- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
2326
- description: >-
2327
- The API data type Longitude is a JSON String in a lexical format that is
2328
- restricted by a regular expression for interoperability reasons.
2329
- money:
2330
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2331
- type: string
2332
- participantsResponse:
2333
- type: object
2334
- properties: *ref_4
2335
- payerType:
2336
- type: string
2337
- enum: *ref_29
2338
- quoteId:
2339
- pattern: >-
2340
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2341
- type: string
2342
- description: A Mojaloop API quote identifier (UUID).
2343
- quoteRequest:
2344
- type: object
2345
- description: A request for a quote for transfer from the DFSP backend.
2346
- required: *ref_30
2347
- properties: *ref_31
2348
- quoteResponse:
2349
- type: object
2350
- description: A response to a request for a quote.
2351
- required: *ref_14
2352
- properties: *ref_15
2353
- timestamp:
2354
- type: string
2355
- pattern: >-
2356
- ^(?:[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)$
2357
- description: An ISO-8601 formatted timestamp.
2358
- transactionId:
2359
- pattern: >-
2360
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2361
- type: string
2362
- description: >-
2363
- ID of the transaction, the ID is decided by the Payer FSP during the
2364
- creation of the quote.
2365
- transactionType:
2366
- type: string
2367
- enum: *ref_17
2368
- scenario:
2369
- type: string
2370
- enum: *ref_32
2371
- amountCurrency:
2372
- type: object
2373
- description: Object containing Amount and Currency of the transfer.
2374
- required: *ref_33
2375
- properties: *ref_34
2376
- transactionTypeObject:
2377
- type: object
2378
- description: Object containing transfer object.
2379
- required: *ref_35
2380
- properties: *ref_36
2381
- ilpPacketData:
2382
- type: object
2383
- description: Object containing transfer object.
2384
- required: *ref_37
2385
- properties: *ref_38
2386
- transferId:
2387
- pattern: >-
2388
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2389
- type: string
2390
- description: A Mojaloop API transfer identifier (UUID).
2391
- transferParty:
2392
- type: object
2393
- required: *ref_8
2394
- properties: *ref_9
2395
- transferState:
2396
- type: string
2397
- enum: *ref_20
2398
- description: >
2399
- Below are the allowed values for the enumeration - RECEIVED DFSP has
2400
- received the transfer. - RESERVED DFSP has reserved the transfer. -
2401
- COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP
2402
- has aborted the transfer due a rejection or failure to perform the
2403
- transfer.
2404
- transferRequest:
2405
- type: object
2406
- required: *ref_39
2407
- properties: *ref_40
2408
- transferResponse:
2409
- type: object
2410
- required: *ref_41
2411
- properties: *ref_42
2412
- transferDetailsResponse:
2413
- type: object
2414
- required: *ref_43
2415
- properties: *ref_44
2416
- transferStatus:
2417
- type: string
2418
- enum: *ref_45
2419
- fulfilNotification:
2420
- title: TransfersIDPatchResponse
2421
- type: object
2422
- description: PUT /transfers/{transferId} object
2423
- properties: *ref_46
2424
- extensionListComplex:
2425
- type: object
2426
- description: Data model for the complex type ExtensionList
2427
- properties:
2428
- extension:
2429
- type: array
2430
- items:
2431
- type: object
2432
- properties: *ref_28
2433
- minItems: 1
2434
- maxItems: 16
2435
- description: Number of Extension elements
2436
- required:
2437
- - extension
2438
- generalError:
2439
- type: object
2440
- description: >-
2441
- This object may represent a number of different error object types and
2442
- so its properties may vary significantly.
2443
- IlpFulfilment:
2444
- title: IlpFulfilment
2445
- type: string
2446
- pattern: ^[A-Za-z0-9-_]{43}$
2447
- maxLength: 48
2448
- description: Fulfilment that must be attached to the transfer by the Payee.
2449
- example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
2450
- ErrorCode:
2451
- title: ErrorCode
2452
- type: string
2453
- pattern: ^[1-9]\d{3}$
2454
- description: >-
2455
- The API data type ErrorCode is a JSON String of four characters,
2456
- consisting of digits only. Negative numbers are not allowed. A leading
2457
- zero is not allowed. Each error code in the API is a four-digit number,
2458
- for example, 1234, where the first number (1 in the example) represents
2459
- the high-level error category, the second number (2 in the example)
2460
- represents the low-level error category, and the last two numbers (34 in
2461
- the example) represent the specific error.
2462
- example: '5100'
2463
- ErrorDescription:
2464
- title: ErrorDescription
2465
- type: string
2466
- minLength: 1
2467
- maxLength: 128
2468
- description: Error description string.
2469
- ExtensionKey:
2470
- title: ExtensionKey
2471
- type: string
2472
- minLength: 1
2473
- maxLength: 32
2474
- description: Extension key.
2475
- ExtensionValue:
2476
- title: ExtensionValue
2477
- type: string
2478
- minLength: 1
2479
- maxLength: 128
2480
- description: Extension value.
2481
- Extension:
2482
- title: Extension
2483
- type: object
2484
- description: Data model for the complex type Extension.
2485
- properties: *ref_47
2486
- required: *ref_48
2487
- ExtensionList:
2488
- title: ExtensionList
2489
- type: object
2490
- description: >-
2491
- Data model for the complex type ExtensionList. An optional list of
2492
- extensions, specific to deployment.
2493
- properties: *ref_21
2494
- required: *ref_22
2495
- ErrorInformation:
2496
- title: ErrorInformation
2497
- type: object
2498
- description: Data model for the complex type ErrorInformation.
2499
- properties: *ref_49
2500
- required: *ref_50
2501
- mojaloopError:
2502
- type: object
2503
- properties: *ref_51
2504
- transferError:
2505
- type: object
2506
- description: >-
2507
- This object represents a Mojaloop API error received at any time during
2508
- the transfer process
2509
- properties: *ref_26
2510
- CorrelationId:
2511
- title: CorrelationId
2512
- type: string
2513
- pattern: >-
2514
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2515
- description: >-
2516
- Identifier that correlates all messages of the same sequence. The API
2517
- data type UUID (Universally Unique Identifier) is a JSON String in
2518
- canonical format, conforming to [RFC
2519
- 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
2520
- regular expression for interoperability reasons. A UUID is always 36
2521
- characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
2522
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2523
- bulkTransactionStatus:
2524
- type: string
2525
- enum: *ref_52
2526
- autoAcceptPartyOption:
2527
- type: object
2528
- required: *ref_53
2529
- properties: *ref_54
2530
- Currency:
2531
- title: Currency
2532
- description: >-
2533
- The currency codes defined in [ISO
2534
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
2535
- alphabetic codes are used as the standard naming representation for
2536
- currencies.
2537
- type: string
2538
- minLength: 3
2539
- maxLength: 3
2540
- enum: *ref_23
2541
- Amount:
2542
- title: Amount
2543
- type: string
2544
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2545
- description: >-
2546
- The API data type Amount is a JSON String in a canonical format that is
2547
- restricted by a regular expression for interoperability reasons. This
2548
- pattern does not allow any trailing zeroes at all, but allows an amount
2549
- without a minor currency unit. It also only allows four digits in the
2550
- minor currency unit; a negative value is not allowed. Using more than 18
2551
- digits in the major currency unit is not allowed.
2552
- example: '123.45'
2553
- bulkPerTransferFeeLimit:
2554
- type: object
2555
- required: *ref_55
2556
- properties: *ref_56
2557
- autoAcceptQuote:
2558
- type: object
2559
- required: *ref_57
2560
- properties: *ref_58
2561
- DateTime:
2562
- title: DateTime
2563
- type: string
2564
- pattern: >-
2565
- ^(?:[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)$
2566
- description: >-
2567
- The API data type DateTime is a JSON String in a lexical format that is
2568
- restricted by a regular expression for interoperability reasons. The
2569
- format is according to [ISO
2570
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed
2571
- in a combined date, time and time zone format. A more readable version
2572
- of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
2573
- "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
2574
- indicates Zulu time zone, same as UTC).
2575
- example: '2016-05-24T08:38:08.699-04:00'
2576
- bulkTransactionOptions:
2577
- type: object
2578
- required: *ref_59
2579
- properties: *ref_60
2580
- PartyIdType:
2581
- title: PartyIdType
2582
- type: string
2583
- enum: *ref_61
2584
- description: >-
2585
- Below are the allowed values for the enumeration.
2586
-
2587
- - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
2588
- Number, that is, the phone number) is used as reference to a
2589
- participant. The MSISDN identifier should be in international format
2590
- according to the [ITU-T E.164
2591
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
2592
- MSISDN may be prefixed by a single plus sign, indicating the
2593
- international prefix.
2594
-
2595
- - EMAIL - An email is used as reference to a participant. The format of
2596
- the email should be according to the informational [RFC
2597
- 3696](https://tools.ietf.org/html/rfc3696).
2598
-
2599
- - PERSONAL_ID - A personal identifier is used as reference to a
2600
- participant. Examples of personal identification are passport number,
2601
- birth certificate number, and national registration number. The
2602
- identifier number is added in the PartyIdentifier element. The personal
2603
- identifier type is added in the PartySubIdOrType element.
2604
-
2605
- - BUSINESS - A specific Business (for example, an organization or a
2606
- company) is used as reference to a participant. The BUSINESS identifier
2607
- can be in any format. To make a transaction connected to a specific
2608
- username or bill number in a Business, the PartySubIdOrType element
2609
- should be used.
2610
-
2611
- - DEVICE - A specific device (for example, a POS or ATM) ID connected to
2612
- a specific business or organization is used as reference to a Party. For
2613
- referencing a specific device under a specific business or organization,
2614
- use the PartySubIdOrType element.
2615
-
2616
- - ACCOUNT_ID - A bank account number or FSP account ID should be used as
2617
- reference to a participant. The ACCOUNT_ID identifier can be in any
2618
- format, as formats can greatly differ depending on country and FSP.
2619
-
2620
- - IBAN - A bank account number or FSP account ID is used as reference to
2621
- a participant. The IBAN identifier can consist of up to 34 alphanumeric
2622
- characters and should be entered without whitespace.
2623
-
2624
- - ALIAS An alias is used as reference to a participant. The alias should
2625
- be created in the FSP as an alternative reference to an account owner.
2626
- Another example of an alias is a username in the FSP system. The ALIAS
2627
- identifier can be in any format. It is also possible to use the
2628
- PartySubIdOrType element for identifying an account under an Alias
2629
- defined by the PartyIdentifier.
2630
- PartyIdentifier:
2631
- title: PartyIdentifier
2632
- type: string
2633
- minLength: 1
2634
- maxLength: 128
2635
- description: Identifier of the Party.
2636
- example: '16135551212'
2637
- PartySubIdOrType:
2638
- title: PartySubIdOrType
2639
- type: string
2640
- minLength: 1
2641
- maxLength: 128
2642
- description: >-
2643
- Either a sub-identifier of a PartyIdentifier, or a sub-type of the
2644
- PartyIdType, normally a PersonalIdentifierType.
2645
- FspId:
2646
- title: FspId
2647
- type: string
2648
- minLength: 1
2649
- maxLength: 32
2650
- description: FSP identifier.
2651
- PartyIdInfo:
2652
- title: PartyIdInfo
2653
- type: object
2654
- description: >-
2655
- Data model for the complex type PartyIdInfo. An ExtensionList element
2656
- has been added to this reqeust in version v1.1
2657
- properties: *ref_62
2658
- required: *ref_63
2659
- MerchantClassificationCode:
2660
- title: MerchantClassificationCode
2661
- type: string
2662
- pattern: ^[\d]{1,4}$
2663
- description: >-
2664
- A limited set of pre-defined numbers. This list would be a limited set
2665
- of numbers identifying a set of popular merchant types like School Fees,
2666
- Pubs and Restaurants, Groceries, etc.
2667
- PartyName:
2668
- title: PartyName
2669
- type: string
2670
- minLength: 1
2671
- maxLength: 128
2672
- description: Name of the Party. Could be a real name or a nickname.
2673
- FirstName:
2674
- title: FirstName
2675
- type: string
2676
- minLength: 1
2677
- maxLength: 128
2678
- pattern: >-
2679
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2680
- .,''-]{1,128}$
2681
- description: First name of the Party (Name Type).
2682
- example: Henrik
2683
- MiddleName:
2684
- title: MiddleName
2685
- type: string
2686
- minLength: 1
2687
- maxLength: 128
2688
- pattern: >-
2689
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2690
- .,''-]{1,128}$
2691
- description: Middle name of the Party (Name Type).
2692
- example: Johannes
2693
- LastName:
2694
- title: LastName
2695
- type: string
2696
- minLength: 1
2697
- maxLength: 128
2698
- pattern: >-
2699
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2700
- .,''-]{1,128}$
2701
- description: Last name of the Party (Name Type).
2702
- example: Karlsson
2703
- PartyComplexName:
2704
- title: PartyComplexName
2705
- type: object
2706
- description: Data model for the complex type PartyComplexName.
2707
- properties: *ref_64
2708
- DateOfBirth:
2709
- title: DateofBirth (type Date)
2710
- type: string
2711
- pattern: >-
2712
- ^(?:[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)$
2713
- description: Date of Birth of the Party.
2714
- example: '1966-06-16'
2715
- PartyPersonalInfo:
2716
- title: PartyPersonalInfo
2717
- type: object
2718
- description: Data model for the complex type PartyPersonalInfo.
2719
- properties: *ref_65
2720
- Party:
2721
- title: Party
2722
- type: object
2723
- description: Data model for the complex type Party.
2724
- properties: *ref_66
2725
- required: *ref_67
2726
- AmountType:
2727
- title: AmountType
2728
- type: string
2729
- enum: *ref_68
2730
- description: >-
2731
- Below are the allowed values for the enumeration AmountType.
2732
-
2733
- - SEND - Amount the Payer would like to send, that is, the amount that
2734
- should be withdrawn from the Payer account including any fees.
2735
-
2736
- - RECEIVE - Amount the Payer would like the Payee to receive, that is,
2737
- the amount that should be sent to the receiver exclusive of any fees.
2738
- example: RECEIVE
2739
- Note:
2740
- title: Note
2741
- type: string
2742
- minLength: 1
2743
- maxLength: 128
2744
- description: Memo assigned to transaction.
2745
- example: Note sent to Payee.
2746
- Money:
2747
- title: Money
2748
- type: object
2749
- description: Data model for the complex type Money.
2750
- properties: *ref_24
2751
- required: *ref_25
2752
- Latitude:
2753
- title: Latitude
2754
- type: string
2755
- pattern: >-
2756
- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
2757
- description: >-
2758
- The API data type Latitude is a JSON String in a lexical format that is
2759
- restricted by a regular expression for interoperability reasons.
2760
- example: '+45.4215'
2761
- Longitude:
2762
- title: Longitude
2763
- type: string
2764
- pattern: >-
2765
- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
2766
- description: >-
2767
- The API data type Longitude is a JSON String in a lexical format that is
2768
- restricted by a regular expression for interoperability reasons.
2769
- example: '+75.6972'
2770
- GeoCode:
2771
- title: GeoCode
2772
- type: object
2773
- description: >-
2774
- Data model for the complex type GeoCode. Indicates the geographic
2775
- location from where the transaction was initiated.
2776
- properties: *ref_69
2777
- required: *ref_70
2778
- IlpPacket:
2779
- title: IlpPacket
2780
- type: string
2781
- pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
2782
- minLength: 1
2783
- maxLength: 32768
2784
- description: Information for recipient (transport layer information).
2785
- example: >-
2786
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
2787
- IlpCondition:
2788
- title: IlpCondition
2789
- type: string
2790
- pattern: ^[A-Za-z0-9-_]{43}$
2791
- maxLength: 48
2792
- description: Condition that must be attached to the transfer by the Payer.
2793
- QuotesIDPutResponse:
2794
- title: QuotesIDPutResponse
2795
- type: object
2796
- description: The object sent in the PUT /quotes/{ID} callback.
2797
- properties: *ref_71
2798
- required: *ref_72
2799
- TransferState:
2800
- title: TransferState
2801
- type: string
2802
- enum: *ref_73
2803
- description: >-
2804
- Below are the allowed values for the enumeration.
2805
-
2806
- - RECEIVED - Next ledger has received the transfer.
2807
-
2808
- - RESERVED - Next ledger has reserved the transfer.
2809
-
2810
- - COMMITTED - Next ledger has successfully performed the transfer.
2811
-
2812
- - ABORTED - Next ledger has aborted the transfer due to a rejection or
2813
- failure to perform the transfer.
2814
- example: RESERVED
2815
- TransfersIDPutResponse:
2816
- title: TransfersIDPutResponse
2817
- type: object
2818
- description: The object sent in the PUT /transfers/{ID} callback.
2819
- properties: *ref_74
2820
- required: *ref_75
2821
- bulkTransactionIndividualTransferResult:
2822
- type: object
2823
- required: *ref_76
2824
- properties: *ref_77
2825
- bulkTransactionResponse:
2826
- title: BulkTransactionResponse
2827
- type: object
2828
- required: *ref_78
2829
- properties: *ref_79
2830
- responses:
2831
- '400':
2832
- description: Malformed or missing required headers or parameters
2833
- content: *ref_5
2834
- '404':
2835
- description: >-
2836
- The party specified by the provided identifier type and value is not
2837
- known to the server
2838
- '500':
2839
- description: An error occurred processing the request
2840
- content: *ref_6
2841
- parameters:
2842
- transferId:
2843
- name: transferId
2844
- in: path
2845
- required: true
2846
- schema: *ref_80
2847
- idType:
2848
- name: idType
2849
- in: path
2850
- required: true
2851
- schema: *ref_2
2852
- description: >
2853
- Below are the allowed values for the enumeration.
2854
-
2855
-
2856
- - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
2857
- Number, that is, the phone number) is used as reference to a
2858
- participant. The MSISDN identifier should be in international format
2859
- according to the [ITU-T E.164
2860
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
2861
- MSISDN may be prefixed by a single plus sign, indicating the
2862
- international prefix.
2863
-
2864
-
2865
- - ACCOUNT_ID - A bank account number or FSP account ID should be used as
2866
- reference to a participant. The ACCOUNT_ID identifier can be in any
2867
- format, as formats can greatly differ depending on country and FSP.
2868
- idValue:
2869
- name: idValue
2870
- in: path
2871
- required: true
2872
- schema: *ref_3
2873
- description: Identifier of the party.
2874
- idSubValue:
2875
- name: idSubValue
2876
- in: path
2877
- required: true
2878
- schema: *ref_7
2879
- description: >-
2880
- Either a sub-identifier of a `{idValue}`, or a sub-type of the
2881
- `{idType}`, normally a `{personalIdType}`
2882
- bulkTransactionId:
2883
- name: bulkTransactionId
2884
- in: path
2885
- required: true
2886
- schema: *ref_81
2887
- description: >-
2888
- Identifier of the bulk transaction to continue as returned in the
2889
- response to a `POST /bulkTransaction` request.