forked from infitx-org/mojaloop-connector
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdfspInboundApi.yaml
1102 lines (1023 loc) · 34.1 KB
/
dfspInboundApi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Mojaloop SDK Inbound Scheme Adapter API
description: >
API specification for the Mojaloop SDK Inbound Scheme Adapter API – to be implemented by the Digital Financial Service Provider's (DFSP) backend.
**Note on terminology:** The term "Switch" is equal to the term "Hub", and the term "FSP" is equal to the term "DFSP".
license:
name: Apache License Version 2.0, January 2004
url: http://www.apache.org/licenses/
version: 1.1.0
paths:
/participants/{idType}/{idValue}:
get:
summary: Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value
description: The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located.
tags:
- Participants
parameters:
- $ref: '#/components/parameters/idType'
- $ref: '#/components/parameters/idValue'
responses:
200:
description: Response containing details of the requested party
content:
application/json:
schema:
$ref: '#/components/schemas/participantsResponse'
400:
$ref: '#/components/responses/400'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
/participants/{idType}/{idValue}/{idSubValue}:
get:
summary: Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value
description: The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located.
tags:
- Participants
parameters:
- $ref: '#/components/parameters/idType'
- $ref: '#/components/parameters/idValue'
- $ref: '#/components/parameters/idSubValue'
responses:
200:
description: Response containing details of the requested party
content:
application/json:
schema:
$ref: '#/components/schemas/participantsResponse'
400:
$ref: '#/components/responses/400'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
/parties/{idType}/{idValue}:
get:
summary: Requests information relating to a transfer party identified by the specified identifier type and value
description: The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`.
tags:
- Parties
parameters:
- $ref: '#/components/parameters/idType'
- $ref: '#/components/parameters/idValue'
responses:
200:
description: Response containing details of the requested party
content:
application/json:
schema:
$ref: '#/components/schemas/transferParty'
400:
$ref: '#/components/responses/400'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
/parties/{idType}/{idValue}/{idSubValue}:
get:
summary: Requests information relating to a transfer party identified by the specified identifier type and value
description: The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`.
tags:
- Parties
parameters:
- $ref: '#/components/parameters/idType'
- $ref: '#/components/parameters/idValue'
- $ref: '#/components/parameters/idSubValue'
responses:
200:
description: Response containing details of the requested party
content:
application/json:
schema:
$ref: '#/components/schemas/transferParty'
400:
$ref: '#/components/responses/400'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
/quoterequests:
post:
summary: Requests a quote for the specified transfer
description: The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction.
tags:
- Quotes
requestBody:
description: Request for a transfer quotation
content:
application/json:
schema:
$ref: '#/components/schemas/quoteRequest'
responses:
200:
description: A response to the transfer quotation request
content:
application/json:
schema:
$ref: '#/components/schemas/quoteResponse'
400:
$ref: '#/components/responses/400'
500:
$ref: '#/components/responses/500'
/transfers:
post:
summary: Transfers funds from an external account to an internal account
description: The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party.
tags:
- Transfers
requestBody:
description: An incoming transfer request
content:
application/json:
schema:
$ref: '#/components/schemas/transferRequest'
responses:
200:
description: The transfer was accepted
content:
application/json:
schema:
$ref: '#/components/schemas/transferResponse'
400:
$ref: '#/components/responses/400'
500:
$ref: '#/components/responses/500'
/transfers/{transferId}:
parameters:
- $ref: '#/components/parameters/transferId'
get:
summary: Retrieves information for a specific transfer
description: The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
tags:
- Transfers
responses:
200:
description: The transfer was accepted
content:
application/json:
schema:
$ref: '#/components/schemas/transferDetailsResponse'
500:
$ref: '#/components/responses/500'
put:
summary: Receive notification for a specific transfer
description: The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee
tags:
- Transfers
requestBody:
description: An incoming notification for fulfiled transfer
content:
application/json:
schema:
$ref: '#/components/schemas/fulfilNotification'
responses:
200:
description: The notification was accepted
500:
$ref: '#/components/responses/500'
components:
schemas:
amountType:
type: string
enum:
- SEND
- RECEIVE
description: SEND for send amount, RECEIVE for receive amount.
currency:
maxLength: 3
minLength: 3
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GGP
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- IMP
- INR
- IQD
- IRR
- ISK
- JEP
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SPL
- SRD
- STD
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TVD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XCD
- XDR
- XOF
- XPF
- XTS
- XXX
- YER
- ZAR
- ZMW
- ZWD
dateOfBirth:
type: string
pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
description: Date of birth in the form YYYY-MM-DD.
errorResponse:
type: object
required:
- statusCode
properties:
statusCode:
type: string
description: Error code as string.
message:
type: string
description: Error message text.
fspId:
type: string
minLength: 1
maxLength: 32
description: FSP identifier.
extensionList:
type: array
items:
$ref: '#/components/schemas/extensionItem'
minItems: 0
maxItems: 16
geoCode:
type: object
description: Indicates the geographic location from where the transaction was initiated.
properties:
latitude:
$ref: '#/components/schemas/latitude'
longitude:
$ref: '#/components/schemas/longitude'
required:
- latitude
- longitude
idType:
type: string
enum:
- MSISDN
- ACCOUNT_ID
description: Below are the allowed values for the enumeration.
- MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.
- ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.
personalIdType:
type: string
enum:
- PASSPORT
- NATIONAL_REGISTRATION
- DRIVING_LICENSE
- ALIEN_REGISTRATION
- NATIONAL_ID_CARD
- EMPLOYER_ID
- TAX_ID_NUMBER
- SENIOR_CITIZENS_CARD
- MARRIAGE_CERTIFICATE
- HEALTH_CARD
- VOTERS_ID
- UNITED_NATIONS
- OTHER_ID
description: Below are the allowed values for the enumeration.
- PASSPORT - Apassport number isused in reference to a party.
- NATIONAL_REGISTRATION - Anational registration number isused in reference to a party.
- DRIVING_LICENSE - Adriving license isused in reference to a party.
- ALIEN_REGISTRATION - An alien registration number isused in reference to a party.
- NATIONAL_ID_CARD - Anational ID card number isused in reference to a party.
- EMPLOYER_ID - Atax identification number isused in reference to a party.
- TAX_ID_NUMBER - Atax identification number isused in reference to a party.
- SENIOR_CITIZENS_CARD - Asenior citizens card number isused in reference to a party.
- MARRIAGE_CERTIFICATE - Amarriage certificate number isused in reference to a party.
- HEALTH_CARD - Ahealth card number isused in reference to a party.
- VOTERS_ID - Avoter’s identification number isused in reference to a party.
- UNITED_NATIONS - An UN (United Nations) number isused in reference to a party.
- OTHER_ID - Any other type of identification type number isused in reference to a party.
idValue:
type: string
minLength: 1
maxLength: 128
description: Identifier of the party.
idSubValue:
type: string
minLength: 1
maxLength: 128
description: Either a sub-identifier of a `{idValue}`, or a sub-type of the `{idType}`, normally a `{personalIdType}`
initiator:
type: string
enum:
- PAYER
- PAYEE
description: Specifies if the initiator of the transfer is the Payer or Payee.
extensionItem:
type: object
properties:
key:
type: string
minLength: 1
maxLength: 32
value:
type: string
minLength: 1
maxLength: 128
initiatorType:
type: string
enum:
- CONSUMER
- AGENT
- BUSINESS
- DEVICE
description: Specifies the type of the transaction initiator.
latitude:
type: string
pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
longitude:
type: string
pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
money:
pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
type: string
participantsResponse:
type: object
properties:
fspId:
$ref: '#/components/schemas/fspId'
payerType:
type: string
enum:
- CONSUMER
- AGENT
- BUSINESS
- DEVICE
quoteId:
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
type: string
description: A Mojaloop API quote identifier (UUID).
quoteRequest:
type: object
description: A request for a quote for transfer from the DFSP backend.
required:
- quoteId
- transactionId
- to
- from
- amountType
- amount
- currency
- transactionType
- initiator
- initiatorType
properties:
quoteId:
$ref: '#/components/schemas/quoteId'
transactionId:
$ref: '#/components/schemas/transactionId'
description: Identifier for the transaction, decided by the Payer FSP during the creation of the quote.
to:
$ref: '#/components/schemas/transferParty'
description: Information about the Payee in the proposed financial transaction.
from:
$ref: '#/components/schemas/transferParty'
description: Information about the Payer in the proposed financial transaction.
amountType:
$ref: '#/components/schemas/amountType'
description: SEND for send amount, RECEIVE for receive amount.
amount:
$ref: '#/components/schemas/money'
description: Depending on `amountType`. If SEND - The amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. The amount is updated by each participating entity in the transaction. If RECEIVE - The amount the Payee should receive, that is, the amount that should be sent to the receiver exclusive any fees. The amount is not updated by any of the participating entities.
currency:
$ref: '#/components/schemas/currency'
feesAmount:
$ref: '#/components/schemas/money'
description: The fees in the transaction. The fees element should be empty if fees should be non-disclosed. The fees element should be non-empty if fees should be disclosed.
feesCurrency:
$ref: '#/components/schemas/currency'
transactionType:
$ref: '#/components/schemas/transactionType'
description: Type of transaction for which the quote is requested.
initiator:
$ref: '#/components/schemas/initiator'
description: Specifies if the initiator of the transfer is the Payer or Payee.
initiatorType:
$ref: '#/components/schemas/initiatorType'
description: Specifies the type of the transaction initiator.
geoCode:
$ref: '#/components/schemas/geoCode'
description: Longitude and Latitude of the initiating party. Can be used to detect fraud.
note:
type: string
minLength: 1
maxLength: 128
description: An optional note associated with the requested transfer.
expiration:
$ref: '#/components/schemas/timestamp'
description: An optional deadline for responding to the quote request.
extensionList:
$ref: '#/components/schemas/extensionList'
quoteResponse:
type: object
description: A response to a request for a quote.
required:
- quoteId
- transactionId
- transferAmount
- transferAmountCurrency
properties:
quoteId:
$ref: '#/components/schemas/quoteId'
description: ID of the quote that this response relates to.
transactionId:
$ref: '#/components/schemas/transactionId'
description: Identifier for the transaction, decided by the Payer FSP during the creation of the quote.
transferAmount:
$ref: '#/components/schemas/money'
description: The amount of money that the Payer FSP should transfer to the Payee FSP.
transferAmountCurrency:
$ref: '#/components/schemas/currency'
description: The currency of the `transferAmount`.
payeeReceiveAmount:
$ref: '#/components/schemas/money'
description: The amount that the Payee should receive in the end-to-end transaction. Optional as the Payee FSP might not want to disclose any optional Payee fees.
payeeReceiveAmountCurrency:
$ref: '#/components/schemas/currency'
description: The currency of the `payeeReceiveAmount`.
payeeFspFeeAmount:
$ref: '#/components/schemas/money'
description: Payee FSP’s part of the transaction fee.
payeeFspFeeAmountCurrency:
$ref: '#/components/schemas/currency'
description: The currency of the `payeeFspFeeAmount`.
payeeFspCommissionAmount:
$ref: '#/components/schemas/money'
description: Transaction commission from the Payee FSP.
payeeFspCommissionAmountCurrency:
$ref: '#/components/schemas/currency'
description: Currency of the `payeeFspCommissionAmount`.
expiration:
$ref: '#/components/schemas/timestamp'
description: Timestamp specifying the validity period of the quotation.
geoCode:
$ref: '#/components/schemas/geoCode'
description: Longitude and Latitude of the Payee. Can be used to detect fraud.
extensionList:
$ref: '#/components/schemas/extensionList'
timestamp:
type: string
pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
description: An ISO-8601 formatted timestamp.
transactionId:
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
type: string
description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
transactionType:
type: string
enum:
- TRANSFER
scenario:
type: string
enum:
- TRANSFER
amountCurrency:
type: object
description: Object containing Amount and Currency of the transfer.
required:
- amount
- currency
properties:
amount:
$ref: '#/components/schemas/money'
currency:
$ref: '#/components/schemas/currency'
transactionTypeObject:
type: object
description: Object containing transfer object.
required:
- scenario
- initiator
- initiatorType
properties:
scenario:
$ref: '#/components/schemas/scenario'
initiator:
$ref: '#/components/schemas/initiator'
initiatorType:
$ref: '#/components/schemas/initiatorType'
description: Specifies the type of the transaction initiator.
ilpPacketData:
type: object
description: Object containing transfer object.
required:
- quoteId
- transactionId
- payer
- payee
- amount
- transactionType
properties:
quoteId:
$ref: '#/components/schemas/quoteId'
transactionId:
$ref: '#/components/schemas/transactionId'
description: Identifier for the transaction, decided by the Payer FSP during the creation of the quote.
payer:
$ref: '#/components/schemas/transferParty'
description: Information about the Payer in the proposed financial transaction.
payee:
$ref: '#/components/schemas/transferParty'
description: Information about the Payee in the proposed financial transaction.
amount:
$ref: '#/components/schemas/amountCurrency'
description: Amount and currency of the transaction
transactionType:
$ref: '#/components/schemas/transactionTypeObject'
description: Information about type of transaction and initiator.
transferId:
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
type: string
description: A Mojaloop API transfer identifier (UUID).
transferParty:
type: object
required:
- idType
- idValue
properties:
type:
$ref: '#/components/schemas/payerType'
idType:
$ref: '#/components/schemas/idType'
idValue:
type: string
description: The identifier string used to identify the sender.
idSubValue:
$ref: '#/components/schemas/idSubValue'
displayName:
type: string
description: Display name of the sender, if known.
firstName:
type: string
description: Party first name.
middleName:
type: string
description: Party middle name.
lastName:
type: string
description: Party last name.
dateOfBirth:
$ref: '#/components/schemas/dateOfBirth'
merchantClassificationCode:
type: string
description: Up to 4 digits specifying the sender's merchant classification, if known and applicable.
fspId:
type: string
description: Mojaloop scheme FSPID of the DFSP which owns the party account.
extensionList:
$ref: '#/components/schemas/extensionList'
transferState:
type: string
enum:
- RECEIVED
- RESERVED
- COMMITTED
- ABORTED
description: >
Below are the allowed values for the enumeration
- RECEIVED DFSP has received the transfer.
- RESERVED DFSP has reserved the transfer.
- COMMITTED DFSP has successfully performed the transfer.
- ABORTED DFSP has aborted the transfer due a rejection or failure to perform the transfer.
transferRequest:
type: object
required:
- transferId
- quote
- from
- to
- amountType
- currency
- amount
- transactionType
- ilpPacket
properties:
transferId:
$ref: '#/components/schemas/transferId'
quote:
$ref: '#/components/schemas/quoteResponse'
quoteRequestExtensions:
$ref: '#/components/schemas/extensionList'
from:
$ref: '#/components/schemas/transferParty'
to:
$ref: '#/components/schemas/transferParty'
amountType:
$ref: '#/components/schemas/amountType'
currency:
$ref: '#/components/schemas/currency'
amount:
$ref: '#/components/schemas/money'
transactionType:
$ref: '#/components/schemas/transactionType'
ilpPacket:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/ilpPacketData'
note:
maxLength: 128
type: string
transferResponse:
type: object
required:
- homeTransactionId
properties:
homeTransactionId:
type: string
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
fulfilment:
$ref: '#/components/schemas/IlpFulfilment'
description: Fulfilment from the DFSP backend, used for testing purposes to inject an invalid fulfilment via a rule.
transferState:
$ref: '#/components/schemas/transferState'
description: Transfer state from the DFSP backend, used for testing purposes to inject an desired transfer state via a rule.
example: ABORTED
completedTimestamp:
$ref: '#/components/schemas/timestamp'
description: Completed timestamp from the DFSP backend, used for testing purposes to inject a given completed timestamp via a rule.
example: "2020-05-19T08:38:08.699-04:00"
transferDetailsResponse:
type: object
required:
- homeTransactionId
- from
- to
- amountType
- currency
- amount
- transferState
- transactionType
- timestamp
properties:
homeTransactionId:
type: string
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
from:
$ref: '#/components/schemas/transferParty'
to:
$ref: '#/components/schemas/transferParty'
amountType:
$ref: '#/components/schemas/amountType'
currency:
$ref: '#/components/schemas/currency'
amount:
$ref: '#/components/schemas/money'
transferState:
$ref: '#/components/schemas/transferState'
timestamp:
$ref: '#/components/schemas/timestamp'
transactionType:
$ref: '#/components/schemas/transactionType'
note:
maxLength: 128
type: string
extensions:
$ref: '#/components/schemas/extensionList'
transferStatus:
type: string
enum:
- ERROR_OCCURRED
- WAITING_FOR_PARTY_ACCEPTANCE
- WAITING_FOR_QUOTE_ACCEPTANCE
- COMPLETED
fulfilNotification:
title: TransfersIDPatchResponse
type: object
description: PUT /transfers/{transferId} object
properties:
transferId:
$ref: '#/components/schemas/transferId'
direction:
type: string
enum:
- INBOUND
quoteRequest:
type: object
properties:
headers:
type: object
body:
type: object
quoteResponse:
type: object
properties:
headers:
type: object
body:
type: object
prepare:
type: object
properties:
headers:
type: object
body:
type: object
fulfil:
type: object
properties:
headers:
type: object
body:
type: object
quote:
type: object
properties:
request:
type: object
internalRequest:
type: object
response:
type: object
mojaloopResponse:
type: object
fulfilment:
type: string
currentState:
$ref: '#/components/schemas/transferStatus'
lastError:
$ref: '#/components/schemas/transferError'
initiatedTimestamp:
$ref: '#/components/schemas/timestamp'
finalNotification:
type: object
properties:
completedTimestamp:
$ref: '#/components/schemas/timestamp'
description: Time and date when the transaction was completed.
example: "2020-05-19T08:38:08.699-04:00"
transferState:
$ref: '#/components/schemas/transferState'
description: State of the transfer.
example: COMMITTED
extensionList:
$ref: '#/components/schemas/extensionList'
description: Optional extension, specific to deployment.
required:
- completedTimestamp
- transferState
extensionListComplex:
type: object
description: Data model for the complex type ExtensionList
properties:
extension:
type: array
items:
$ref: '#/components/schemas/extensionItem'
minItems: 1
maxItems: 16
description: Number of Extension elements
required:
- extension
transferError:
type: object
description: This object represents a Mojaloop API error received at any time during the transfer process
properties:
httpStatusCode:
type: integer
description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
mojaloopError:
description: If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.
$ref: '#/components/schemas/mojaloopError'
generalError:
type: object
description: This object may represent a number of different error object types and so its properties may vary significantly.
mojaloopError:
type: object
properties: