@mojaloop/api-snippets 17.0.2-snapshot.0 → 17.0.2-snapshot.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 (9) hide show
  1. package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +1513 -759
  2. package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +7031 -1736
  3. package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +2687 -1232
  4. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.d.ts +4441 -2637
  5. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +40 -15
  6. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
  7. package/lib/sdk-scheme-adapter/v2_0_0/backend/types.d.ts +40 -15
  8. package/package.json +1 -1
  9. package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml +6 -248
package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml CHANGED
@@ -39,7 +39,7 @@ paths:
39
39
  application/json:
40
40
  schema:
41
41
  description: A request for a bulk quote.
42
- properties: &ref_53
42
+ properties: &ref_47
43
43
  bulkQuoteId:
44
44
  description: A Mojaloop API bulk quote identifier (UUID).
45
45
  pattern: >-
@@ -61,8 +61,8 @@ paths:
61
61
  description: Display name of the sender, if known.
62
62
  type: string
63
63
  extensionList:
64
- items: &ref_12
65
- properties: &ref_29
64
+ items: &ref_17
65
+ properties: &ref_51
66
66
  key:
67
67
  maxLength: 32
68
68
  minLength: 1
@@ -88,7 +88,7 @@ paths:
88
88
  minLength: 1
89
89
  type: string
90
90
  idType:
91
- enum: &ref_21
91
+ enum: &ref_55
92
92
  - MSISDN
93
93
  - ACCOUNT_NO
94
94
  - EMAIL
@@ -114,7 +114,7 @@ paths:
114
114
  description: Party middle name.
115
115
  type: string
116
116
  type:
117
- enum: &ref_22
117
+ enum: &ref_60
118
118
  - CONSUMER
119
119
  - AGENT
120
120
  - BUSINESS
@@ -128,7 +128,7 @@ paths:
128
128
  description: >-
129
129
  Indicates the geographic location from where the transaction
130
130
  was initiated.
131
- properties: &ref_19
131
+ properties: &ref_24
132
132
  latitude:
133
133
  description: >-
134
134
  The API data type Latitude is a JSON String in a lexical
@@ -145,19 +145,19 @@ paths:
145
145
  pattern: >-
146
146
  ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
147
147
  type: string
148
- required: &ref_20
148
+ required: &ref_25
149
149
  - latitude
150
150
  - longitude
151
151
  type: object
152
152
  individualQuotes:
153
153
  items:
154
154
  description: Data model for individual quote in a bulk quote request.
155
- properties: &ref_36
155
+ properties: &ref_35
156
156
  amount:
157
157
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
158
158
  type: string
159
159
  amountType:
160
- enum: &ref_8
160
+ enum: &ref_13
161
161
  - SEND
162
162
  - RECEIVE
163
163
  type: string
@@ -339,12 +339,12 @@ paths:
339
339
  minLength: 3
340
340
  type: string
341
341
  initiator:
342
- enum: &ref_9
342
+ enum: &ref_14
343
343
  - PAYER
344
344
  - PAYEE
345
345
  type: string
346
346
  initiatorType:
347
- enum: &ref_10
347
+ enum: &ref_15
348
348
  - CONSUMER
349
349
  - AGENT
350
350
  - BUSINESS
@@ -381,12 +381,12 @@ paths:
381
381
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
382
382
  type: string
383
383
  transactionType:
384
- enum: &ref_11
384
+ enum: &ref_16
385
385
  - TRANSFER
386
386
  - DEPOSIT
387
387
  - PAYMENT
388
388
  type: string
389
- required: &ref_37
389
+ required: &ref_36
390
390
  - quoteId
391
391
  - transactionId
392
392
  - to
@@ -400,7 +400,7 @@ paths:
400
400
  maxItems: 1000
401
401
  minItems: 1
402
402
  type: array
403
- required: &ref_54
403
+ required: &ref_48
404
404
  - bulkQuoteId
405
405
  - from
406
406
  - individualQuotes
@@ -432,7 +432,7 @@ paths:
432
432
  - description: >-
433
433
  Data model for successful individual quote in a bulk
434
434
  quote response.
435
- properties: &ref_40
435
+ properties: &ref_39
436
436
  payeeFspCommissionAmount:
437
437
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
438
438
  type: string
@@ -470,13 +470,13 @@ paths:
470
470
  maxLength: 3
471
471
  minLength: 3
472
472
  type: string
473
- required: &ref_41
473
+ required: &ref_40
474
474
  - quoteId
475
475
  type: object
476
476
  - description: >-
477
477
  Data model for failed individual quote in a bulk
478
478
  quote response.
479
- properties: &ref_38
479
+ properties: &ref_37
480
480
  errorResponse:
481
481
  properties: &ref_3
482
482
  message:
@@ -499,7 +499,7 @@ paths:
499
499
  pattern: >-
500
500
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
501
501
  type: string
502
- required: &ref_39
502
+ required: &ref_38
503
503
  - quoteId
504
504
  - errorResponse
505
505
  type: object
@@ -536,7 +536,7 @@ paths:
536
536
  in: path
537
537
  name: idValue
538
538
  required: true
539
- schema: &ref_13
539
+ schema: &ref_18
540
540
  type: string
541
541
  responses:
542
542
  '200':
@@ -574,11 +574,14 @@ paths:
574
574
  `bulkTransactionId` that was used for the creation of the bulk transfer.
575
575
  operationId: BackendBulkTransactionsPut
576
576
  parameters:
577
- - description: Identifier of the bulk transaction to continue as returned in.
577
+ - name: bulkTransactionId
578
578
  in: path
579
- name: bulkTransactionId
580
579
  required: true
581
- schema: &ref_30
580
+ schema: &ref_34
581
+ title: CorrelationId
582
+ type: string
583
+ pattern: >-
584
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
582
585
  description: >-
583
586
  Identifier that correlates all messages of the same sequence. The
584
587
  API data type UUID (Universally Unique Identifier) is a JSON
@@ -588,36 +591,364 @@ paths:
588
591
  always 36 characters long, 32 hexadecimal symbols and 4 dashes
589
592
  (‘-‘).
590
593
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
591
- pattern: >-
592
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
593
- title: CorrelationId
594
- type: string
594
+ description: >-
595
+ Identifier of the bulk transaction to continue as returned in the
596
+ response to a `POST /bulkTransaction` request.
595
597
  requestBody:
596
598
  content:
597
599
  application/json:
598
600
  schema:
599
- properties:
601
+ title: BulkTransactionResponse
602
+ type: object
603
+ required: &ref_107
604
+ - bulkHomeTransactionID
605
+ - bulkTransactionId
606
+ - currentState
607
+ - individualTransferResults
608
+ properties: &ref_108
600
609
  bulkHomeTransactionID:
610
+ type: string
601
611
  description: >-
602
612
  Transaction ID from the DFSP backend, used to reconcile
603
613
  transactions between the Switch and DFSP backend systems.
614
+ bulkTransactionId:
615
+ title: CorrelationId
616
+ type: string
617
+ pattern: >-
618
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
619
+ description: >-
620
+ Identifier that correlates all messages of the same
621
+ sequence. The API data type UUID (Universally Unique
622
+ Identifier) is a JSON String in canonical format, conforming
623
+ to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
624
+ restricted by a regular expression for interoperability
625
+ reasons. A UUID is always 36 characters long, 32 hexadecimal
626
+ symbols and 4 dashes (‘-‘).
627
+ example: b51ec534-ee48-4575-b6a9-ead2955b8069
628
+ currentState:
604
629
  type: string
630
+ enum: &ref_78
631
+ - ERROR_OCCURRED
632
+ - WAITING_FOR_PARTY_ACCEPTANCE
633
+ - WAITING_FOR_QUOTE_ACCEPTANCE
634
+ - COMPLETED
635
+ options:
636
+ type: object
637
+ required: &ref_85
638
+ - autoAcceptParty
639
+ - autoAcceptQuote
640
+ - bulkExpiration
641
+ properties: &ref_86
642
+ onlyValidateParty:
643
+ description: >-
644
+ Set to true if only party validation is required. This
645
+ means the quotes and transfers will not run. This is
646
+ useful for only party resolution.
647
+ type: boolean
648
+ autoAcceptParty:
649
+ type: object
650
+ required: &ref_79
651
+ - enabled
652
+ properties: &ref_80
653
+ enabled:
654
+ type: boolean
655
+ enum:
656
+ - false
657
+ - true
658
+ autoAcceptQuote:
659
+ description: >-
660
+ Set to true if the quote response is accepted without
661
+ confirmation from the payer. The fees applied by the
662
+ payee will be acceptable to the payer abiding by the
663
+ limits set by optional 'perTransferFeeLimits' array.
664
+ type: object
665
+ oneOf:
666
+ - type: object
667
+ required: &ref_83
668
+ - enabled
669
+ properties: &ref_84
670
+ enabled:
671
+ type: boolean
672
+ enum:
673
+ - true
674
+ - false
675
+ perTransferFeeLimits:
676
+ type: array
677
+ minItems: 0
678
+ items:
679
+ type: object
680
+ required: &ref_81
681
+ - currency
682
+ - amount
683
+ properties: &ref_82
684
+ currency:
685
+ title: Currency
686
+ description: >-
687
+ The currency codes defined in [ISO
688
+ 4217](https://www.iso.org/iso-4217-currency-codes.html)
689
+ as three-letter alphabetic codes are used
690
+ as the standard naming representation for
691
+ currencies.
692
+ type: string
693
+ minLength: 3
694
+ maxLength: 3
695
+ enum: &ref_8
696
+ - AED
697
+ - AFN
698
+ - ALL
699
+ - AMD
700
+ - ANG
701
+ - AOA
702
+ - ARS
703
+ - AUD
704
+ - AWG
705
+ - AZN
706
+ - BAM
707
+ - BBD
708
+ - BDT
709
+ - BGN
710
+ - BHD
711
+ - BIF
712
+ - BMD
713
+ - BND
714
+ - BOB
715
+ - BRL
716
+ - BSD
717
+ - BTN
718
+ - BWP
719
+ - BYN
720
+ - BZD
721
+ - CAD
722
+ - CDF
723
+ - CHF
724
+ - CLP
725
+ - CNY
726
+ - COP
727
+ - CRC
728
+ - CUC
729
+ - CUP
730
+ - CVE
731
+ - CZK
732
+ - DJF
733
+ - DKK
734
+ - DOP
735
+ - DZD
736
+ - EGP
737
+ - ERN
738
+ - ETB
739
+ - EUR
740
+ - FJD
741
+ - FKP
742
+ - GBP
743
+ - GEL
744
+ - GGP
745
+ - GHS
746
+ - GIP
747
+ - GMD
748
+ - GNF
749
+ - GTQ
750
+ - GYD
751
+ - HKD
752
+ - HNL
753
+ - HRK
754
+ - HTG
755
+ - HUF
756
+ - IDR
757
+ - ILS
758
+ - IMP
759
+ - INR
760
+ - IQD
761
+ - IRR
762
+ - ISK
763
+ - JEP
764
+ - JMD
765
+ - JOD
766
+ - JPY
767
+ - KES
768
+ - KGS
769
+ - KHR
770
+ - KMF
771
+ - KPW
772
+ - KRW
773
+ - KWD
774
+ - KYD
775
+ - KZT
776
+ - LAK
777
+ - LBP
778
+ - LKR
779
+ - LRD
780
+ - LSL
781
+ - LYD
782
+ - MAD
783
+ - MDL
784
+ - MGA
785
+ - MKD
786
+ - MMK
787
+ - MNT
788
+ - MOP
789
+ - MRO
790
+ - MUR
791
+ - MVR
792
+ - MWK
793
+ - MXN
794
+ - MYR
795
+ - MZN
796
+ - NAD
797
+ - NGN
798
+ - NIO
799
+ - NOK
800
+ - NPR
801
+ - NZD
802
+ - OMR
803
+ - PAB
804
+ - PEN
805
+ - PGK
806
+ - PHP
807
+ - PKR
808
+ - PLN
809
+ - PYG
810
+ - QAR
811
+ - RON
812
+ - RSD
813
+ - RUB
814
+ - RWF
815
+ - SAR
816
+ - SBD
817
+ - SCR
818
+ - SDG
819
+ - SEK
820
+ - SGD
821
+ - SHP
822
+ - SLL
823
+ - SOS
824
+ - SPL
825
+ - SRD
826
+ - STD
827
+ - SVC
828
+ - SYP
829
+ - SZL
830
+ - THB
831
+ - TJS
832
+ - TMT
833
+ - TND
834
+ - TOP
835
+ - TRY
836
+ - TTD
837
+ - TVD
838
+ - TWD
839
+ - TZS
840
+ - UAH
841
+ - UGX
842
+ - USD
843
+ - UYU
844
+ - UZS
845
+ - VEF
846
+ - VND
847
+ - VUV
848
+ - WST
849
+ - XAF
850
+ - XCD
851
+ - XDR
852
+ - XOF
853
+ - XPF
854
+ - XTS
855
+ - XXX
856
+ - YER
857
+ - ZAR
858
+ - ZMW
859
+ - ZWD
860
+ amount:
861
+ title: Amount
862
+ type: string
863
+ pattern: >-
864
+ ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
865
+ description: >-
866
+ The API data type Amount is a JSON String
867
+ in a canonical format that is restricted
868
+ by a regular expression for
869
+ interoperability reasons. This pattern
870
+ does not allow any trailing zeroes at all,
871
+ but allows an amount without a minor
872
+ currency unit. It also only allows four
873
+ digits in the minor currency unit; a
874
+ negative value is not allowed. Using more
875
+ than 18 digits in the major currency unit
876
+ is not allowed.
877
+ example: '123.45'
878
+ skipPartyLookup:
879
+ description: >-
880
+ Set to true if supplying an FSPID for the payee party
881
+ and no party resolution is needed. This may be useful if
882
+ a previous party resolution has been performed.
883
+ type: boolean
884
+ synchronous:
885
+ description: >-
886
+ Set to true if the bulkTransfer requests need be handled
887
+ synchronous. Otherwise the requests will be handled
888
+ asynchronously, meaning there will be callbacks
889
+ whenever the processing is done
890
+ type: boolean
891
+ bulkExpiration:
892
+ title: DateTime
893
+ type: string
894
+ pattern: >-
895
+ ^(?:[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)$
896
+ description: >-
897
+ The API data type DateTime is a JSON String in a lexical
898
+ format that is restricted by a regular expression for
899
+ interoperability reasons. The format is according to
900
+ [ISO
901
+ 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
902
+ expressed in a combined date, time and time zone format.
903
+ A more readable version of the format is
904
+ yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
905
+ "2016-05-24T08:38:08.699-04:00",
906
+ "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time
907
+ zone, same as UTC).
908
+ example: '2016-05-24T08:38:08.699-04:00'
605
909
  individualTransferResults:
606
910
  description: >-
607
- List of individual transfers in a bulk transfer with accept
608
- party information.
911
+ List of individual transfer result in a bulk transfer
912
+ response.
913
+ type: array
914
+ minItems: 1
609
915
  items:
610
- description: >-
611
- Data model for the 'individualTransfer' while accepting
612
- party or quote.
613
- properties:
916
+ type: object
917
+ required: &ref_105
918
+ - homeTransactionId
919
+ - transferId
920
+ - to
921
+ - amountType
922
+ - currency
923
+ - amount
924
+ properties: &ref_106
925
+ transferId:
926
+ title: CorrelationId
927
+ type: string
928
+ pattern: >-
929
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
930
+ description: >-
931
+ Identifier that correlates all messages of the same
932
+ sequence. The API data type UUID (Universally Unique
933
+ Identifier) is a JSON String in canonical format,
934
+ conforming to [RFC
935
+ 4122](https://tools.ietf.org/html/rfc4122), that is
936
+ restricted by a regular expression for
937
+ interoperability reasons. A UUID is always 36
938
+ characters long, 32 hexadecimal symbols and 4 dashes
939
+ (‘-‘).
940
+ example: b51ec534-ee48-4575-b6a9-ead2955b8069
614
941
  homeTransactionId:
942
+ type: string
615
943
  description: >-
616
944
  Transaction ID from the DFSP backend, used to
617
945
  reconcile transactions between the Switch and DFSP
618
946
  backend systems.
619
- type: string
620
947
  transactionId:
948
+ title: CorrelationId
949
+ type: string
950
+ pattern: >-
951
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
621
952
  description: >-
622
953
  Identifier that correlates all messages of the same
623
954
  sequence. The API data type UUID (Universally Unique
@@ -629,21 +960,593 @@ paths:
629
960
  characters long, 32 hexadecimal symbols and 4 dashes
630
961
  (‘-‘).
631
962
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
632
- pattern: >-
633
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
963
+ to:
964
+ title: Party
965
+ type: object
966
+ description: Data model for the complex type Party.
967
+ properties: &ref_26
968
+ partyIdInfo:
969
+ title: PartyIdInfo
970
+ type: object
971
+ description: >-
972
+ Data model for the complex type PartyIdInfo. An
973
+ ExtensionList element has been added to this
974
+ reqeust in version v1.1
975
+ properties: &ref_90
976
+ partyIdType:
977
+ title: PartyIdType
978
+ type: string
979
+ enum: &ref_87
980
+ - MSISDN
981
+ - EMAIL
982
+ - PERSONAL_ID
983
+ - BUSINESS
984
+ - DEVICE
985
+ - ACCOUNT_ID
986
+ - IBAN
987
+ - ALIAS
988
+ description: >-
989
+ Below are the allowed values for the
990
+ enumeration.
991
+
992
+ - MSISDN - An MSISDN (Mobile Station
993
+ International Subscriber Directory Number,
994
+ that is, the phone number) is used as
995
+ reference to a participant. The MSISDN
996
+ identifier should be in international format
997
+ according to the [ITU-T E.164
998
+ standard](https://www.itu.int/rec/T-REC-E.164/en).
999
+ Optionally, the MSISDN may be prefixed by a
1000
+ single plus sign, indicating the international
1001
+ prefix.
1002
+
1003
+ - EMAIL - An email is used as reference to a
1004
+ participant. The format of the email should be
1005
+ according to the informational [RFC
1006
+ 3696](https://tools.ietf.org/html/rfc3696).
1007
+
1008
+ - PERSONAL_ID - A personal identifier is used
1009
+ as reference to a participant. Examples of
1010
+ personal identification are passport number,
1011
+ birth certificate number, and national
1012
+ registration number. The identifier number is
1013
+ added in the PartyIdentifier element. The
1014
+ personal identifier type is added in the
1015
+ PartySubIdOrType element.
1016
+
1017
+ - BUSINESS - A specific Business (for example,
1018
+ an organization or a company) is used as
1019
+ reference to a participant. The BUSINESS
1020
+ identifier can be in any format. To make a
1021
+ transaction connected to a specific username
1022
+ or bill number in a Business, the
1023
+ PartySubIdOrType element should be used.
1024
+
1025
+ - DEVICE - A specific device (for example, a
1026
+ POS or ATM) ID connected to a specific
1027
+ business or organization is used as reference
1028
+ to a Party. For referencing a specific device
1029
+ under a specific business or organization, use
1030
+ the PartySubIdOrType element.
1031
+
1032
+ - ACCOUNT_ID - A bank account number or FSP
1033
+ account ID should be used as reference to a
1034
+ participant. The ACCOUNT_ID identifier can be
1035
+ in any format, as formats can greatly differ
1036
+ depending on country and FSP.
1037
+
1038
+ - IBAN - A bank account number or FSP account
1039
+ ID is used as reference to a participant. The
1040
+ IBAN identifier can consist of up to 34
1041
+ alphanumeric characters and should be entered
1042
+ without whitespace.
1043
+
1044
+ - ALIAS An alias is used as reference to a
1045
+ participant. The alias should be created in
1046
+ the FSP as an alternative reference to an
1047
+ account owner. Another example of an alias is
1048
+ a username in the FSP system. The ALIAS
1049
+ identifier can be in any format. It is also
1050
+ possible to use the PartySubIdOrType element
1051
+ for identifying an account under an Alias
1052
+ defined by the PartyIdentifier.
1053
+ partyIdentifier:
1054
+ title: PartyIdentifier
1055
+ type: string
1056
+ minLength: 1
1057
+ maxLength: 128
1058
+ description: Identifier of the Party.
1059
+ example: '16135551212'
1060
+ partySubIdOrType:
1061
+ title: PartySubIdOrType
1062
+ type: string
1063
+ minLength: 1
1064
+ maxLength: 128
1065
+ description: >-
1066
+ Either a sub-identifier of a PartyIdentifier,
1067
+ or a sub-type of the PartyIdType, normally a
1068
+ PersonalIdentifierType.
1069
+ fspId:
1070
+ title: FspId
1071
+ type: string
1072
+ minLength: 1
1073
+ maxLength: 32
1074
+ description: FSP identifier.
1075
+ extensionList:
1076
+ title: ExtensionList
1077
+ type: object
1078
+ description: >-
1079
+ Data model for the complex type ExtensionList.
1080
+ An optional list of extensions, specific to
1081
+ deployment.
1082
+ properties: &ref_11
1083
+ extension:
1084
+ type: array
1085
+ items:
1086
+ title: Extension
1087
+ type: object
1088
+ description: >-
1089
+ Data model for the complex type
1090
+ Extension.
1091
+ properties: &ref_88
1092
+ key:
1093
+ title: ExtensionKey
1094
+ type: string
1095
+ minLength: 1
1096
+ maxLength: 32
1097
+ description: Extension key.
1098
+ value:
1099
+ title: ExtensionValue
1100
+ type: string
1101
+ minLength: 1
1102
+ maxLength: 128
1103
+ description: Extension value.
1104
+ required: &ref_89
1105
+ - key
1106
+ - value
1107
+ minItems: 1
1108
+ maxItems: 16
1109
+ description: Number of Extension elements.
1110
+ required: &ref_12
1111
+ - extension
1112
+ required: &ref_91
1113
+ - partyIdType
1114
+ - partyIdentifier
1115
+ merchantClassificationCode:
1116
+ title: MerchantClassificationCode
1117
+ type: string
1118
+ pattern: ^[\d]{1,4}$
1119
+ description: >-
1120
+ A limited set of pre-defined numbers. This list
1121
+ would be a limited set of numbers identifying a
1122
+ set of popular merchant types like School Fees,
1123
+ Pubs and Restaurants, Groceries, etc.
1124
+ name:
1125
+ title: PartyName
1126
+ type: string
1127
+ minLength: 1
1128
+ maxLength: 128
1129
+ description: >-
1130
+ Name of the Party. Could be a real name or a
1131
+ nickname.
1132
+ personalInfo:
1133
+ title: PartyPersonalInfo
1134
+ type: object
1135
+ description: Data model for the complex type PartyPersonalInfo.
1136
+ properties: &ref_93
1137
+ complexName:
1138
+ title: PartyComplexName
1139
+ type: object
1140
+ description: >-
1141
+ Data model for the complex type
1142
+ PartyComplexName.
1143
+ properties: &ref_92
1144
+ firstName:
1145
+ title: FirstName
1146
+ type: string
1147
+ minLength: 1
1148
+ maxLength: 128
1149
+ pattern: >-
1150
+ ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1151
+ .,''-]{1,128}$
1152
+ description: First name of the Party (Name Type).
1153
+ example: Henrik
1154
+ middleName:
1155
+ title: MiddleName
1156
+ type: string
1157
+ minLength: 1
1158
+ maxLength: 128
1159
+ pattern: >-
1160
+ ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1161
+ .,''-]{1,128}$
1162
+ description: Middle name of the Party (Name Type).
1163
+ example: Johannes
1164
+ lastName:
1165
+ title: LastName
1166
+ type: string
1167
+ minLength: 1
1168
+ maxLength: 128
1169
+ pattern: >-
1170
+ ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1171
+ .,''-]{1,128}$
1172
+ description: Last name of the Party (Name Type).
1173
+ example: Karlsson
1174
+ dateOfBirth:
1175
+ title: DateofBirth (type Date)
1176
+ type: string
1177
+ pattern: >-
1178
+ ^(?:[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)$
1179
+ description: Date of Birth of the Party.
1180
+ example: '1966-06-16'
1181
+ required: &ref_27
1182
+ - partyIdInfo
1183
+ reference:
1184
+ description: Payer Loan reference
1185
+ type: string
1186
+ amountType:
1187
+ title: AmountType
1188
+ type: string
1189
+ enum: &ref_94
1190
+ - SEND
1191
+ - RECEIVE
1192
+ description: >-
1193
+ Below are the allowed values for the enumeration
1194
+ AmountType.
1195
+
1196
+ - SEND - Amount the Payer would like to send, that is,
1197
+ the amount that should be withdrawn from the Payer
1198
+ account including any fees.
1199
+
1200
+ - RECEIVE - Amount the Payer would like the Payee to
1201
+ receive, that is, the amount that should be sent to
1202
+ the receiver exclusive of any fees.
1203
+ example: RECEIVE
1204
+ currency:
1205
+ title: Currency
1206
+ description: >-
1207
+ The currency codes defined in [ISO
1208
+ 4217](https://www.iso.org/iso-4217-currency-codes.html)
1209
+ as three-letter alphabetic codes are used as the
1210
+ standard naming representation for currencies.
1211
+ type: string
1212
+ minLength: 3
1213
+ maxLength: 3
1214
+ enum: *ref_8
1215
+ amount:
1216
+ title: Amount
1217
+ type: string
1218
+ pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1219
+ description: >-
1220
+ The API data type Amount is a JSON String in a
1221
+ canonical format that is restricted by a regular
1222
+ expression for interoperability reasons. This pattern
1223
+ does not allow any trailing zeroes at all, but allows
1224
+ an amount without a minor currency unit. It also only
1225
+ allows four digits in the minor currency unit; a
1226
+ negative value is not allowed. Using more than 18
1227
+ digits in the major currency unit is not allowed.
1228
+ example: '123.45'
1229
+ note:
1230
+ title: Note
1231
+ type: string
1232
+ minLength: 1
1233
+ maxLength: 128
1234
+ description: Memo assigned to transaction.
1235
+ example: Note sent to Payee.
1236
+ quoteId:
634
1237
  title: CorrelationId
635
1238
  type: string
636
- required:
637
- - homeTransactionId
638
- type: object
639
- minItems: 1
640
- type: array
641
- required:
642
- - bulkHomeTransactionID
643
- - individualTransferResults
644
- type: object
645
- description: Bulk transaction request body.
646
- required: true
1239
+ pattern: >-
1240
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1241
+ description: >-
1242
+ Identifier that correlates all messages of the same
1243
+ sequence. The API data type UUID (Universally Unique
1244
+ Identifier) is a JSON String in canonical format,
1245
+ conforming to [RFC
1246
+ 4122](https://tools.ietf.org/html/rfc4122), that is
1247
+ restricted by a regular expression for
1248
+ interoperability reasons. A UUID is always 36
1249
+ characters long, 32 hexadecimal symbols and 4 dashes
1250
+ (‘-‘).
1251
+ example: b51ec534-ee48-4575-b6a9-ead2955b8069
1252
+ quoteResponse:
1253
+ title: QuotesIDPutResponse
1254
+ type: object
1255
+ description: The object sent in the PUT /quotes/{ID} callback.
1256
+ properties: &ref_97
1257
+ transferAmount:
1258
+ title: Money
1259
+ type: object
1260
+ description: Data model for the complex type Money.
1261
+ properties: &ref_9
1262
+ currency:
1263
+ title: Currency
1264
+ description: >-
1265
+ The currency codes defined in [ISO
1266
+ 4217](https://www.iso.org/iso-4217-currency-codes.html)
1267
+ as three-letter alphabetic codes are used as
1268
+ the standard naming representation for
1269
+ currencies.
1270
+ type: string
1271
+ minLength: 3
1272
+ maxLength: 3
1273
+ enum: *ref_8
1274
+ amount:
1275
+ title: Amount
1276
+ type: string
1277
+ pattern: >-
1278
+ ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1279
+ description: >-
1280
+ The API data type Amount is a JSON String in a
1281
+ canonical format that is restricted by a
1282
+ regular expression for interoperability
1283
+ reasons. This pattern does not allow any
1284
+ trailing zeroes at all, but allows an amount
1285
+ without a minor currency unit. It also only
1286
+ allows four digits in the minor currency unit;
1287
+ a negative value is not allowed. Using more
1288
+ than 18 digits in the major currency unit is
1289
+ not allowed.
1290
+ example: '123.45'
1291
+ required: &ref_10
1292
+ - currency
1293
+ - amount
1294
+ payeeReceiveAmount:
1295
+ title: Money
1296
+ type: object
1297
+ description: Data model for the complex type Money.
1298
+ properties: *ref_9
1299
+ required: *ref_10
1300
+ payeeFspFee:
1301
+ title: Money
1302
+ type: object
1303
+ description: Data model for the complex type Money.
1304
+ properties: *ref_9
1305
+ required: *ref_10
1306
+ payeeFspCommission:
1307
+ title: Money
1308
+ type: object
1309
+ description: Data model for the complex type Money.
1310
+ properties: *ref_9
1311
+ required: *ref_10
1312
+ expiration:
1313
+ title: DateTime
1314
+ type: string
1315
+ pattern: >-
1316
+ ^(?:[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)$
1317
+ description: >-
1318
+ The API data type DateTime is a JSON String in a
1319
+ lexical format that is restricted by a regular
1320
+ expression for interoperability reasons. The
1321
+ format is according to [ISO
1322
+ 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
1323
+ expressed in a combined date, time and time zone
1324
+ format. A more readable version of the format is
1325
+ yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
1326
+ "2016-05-24T08:38:08.699-04:00",
1327
+ "2016-05-24T08:38:08.699Z" (where Z indicates Zulu
1328
+ time zone, same as UTC).
1329
+ example: '2016-05-24T08:38:08.699-04:00'
1330
+ geoCode:
1331
+ title: GeoCode
1332
+ type: object
1333
+ description: >-
1334
+ Data model for the complex type GeoCode. Indicates
1335
+ the geographic location from where the transaction
1336
+ was initiated.
1337
+ properties: &ref_95
1338
+ latitude:
1339
+ title: Latitude
1340
+ type: string
1341
+ pattern: >-
1342
+ ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
1343
+ description: >-
1344
+ The API data type Latitude is a JSON String in
1345
+ a lexical format that is restricted by a
1346
+ regular expression for interoperability
1347
+ reasons.
1348
+ example: '+45.4215'
1349
+ longitude:
1350
+ title: Longitude
1351
+ type: string
1352
+ pattern: >-
1353
+ ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
1354
+ description: >-
1355
+ The API data type Longitude is a JSON String
1356
+ in a lexical format that is restricted by a
1357
+ regular expression for interoperability
1358
+ reasons.
1359
+ example: '+75.6972'
1360
+ required: &ref_96
1361
+ - latitude
1362
+ - longitude
1363
+ ilpPacket:
1364
+ title: IlpPacket
1365
+ type: string
1366
+ pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
1367
+ minLength: 1
1368
+ maxLength: 32768
1369
+ description: >-
1370
+ Information for recipient (transport layer
1371
+ information).
1372
+ example: >-
1373
+ AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
1374
+ condition:
1375
+ title: IlpCondition
1376
+ type: string
1377
+ pattern: ^[A-Za-z0-9-_]{43}$
1378
+ maxLength: 48
1379
+ description: >-
1380
+ Condition that must be attached to the transfer by
1381
+ the Payer.
1382
+ extensionList:
1383
+ title: ExtensionList
1384
+ type: object
1385
+ description: >-
1386
+ Data model for the complex type ExtensionList. An
1387
+ optional list of extensions, specific to
1388
+ deployment.
1389
+ properties: *ref_11
1390
+ required: *ref_12
1391
+ required: &ref_98
1392
+ - transferAmount
1393
+ - expiration
1394
+ - ilpPacket
1395
+ - condition
1396
+ fulfil:
1397
+ title: TransfersIDPutResponse
1398
+ type: object
1399
+ description: The object sent in the PUT /transfers/{ID} callback.
1400
+ properties: &ref_100
1401
+ fulfilment:
1402
+ title: IlpFulfilment
1403
+ type: string
1404
+ pattern: ^[A-Za-z0-9-_]{43}$
1405
+ maxLength: 48
1406
+ description: >-
1407
+ Fulfilment that must be attached to the transfer
1408
+ by the Payee.
1409
+ example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
1410
+ completedTimestamp:
1411
+ title: DateTime
1412
+ type: string
1413
+ pattern: >-
1414
+ ^(?:[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)$
1415
+ description: >-
1416
+ The API data type DateTime is a JSON String in a
1417
+ lexical format that is restricted by a regular
1418
+ expression for interoperability reasons. The
1419
+ format is according to [ISO
1420
+ 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
1421
+ expressed in a combined date, time and time zone
1422
+ format. A more readable version of the format is
1423
+ yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
1424
+ "2016-05-24T08:38:08.699-04:00",
1425
+ "2016-05-24T08:38:08.699Z" (where Z indicates Zulu
1426
+ time zone, same as UTC).
1427
+ example: '2016-05-24T08:38:08.699-04:00'
1428
+ transferState:
1429
+ title: TransferState
1430
+ type: string
1431
+ enum: &ref_99
1432
+ - RECEIVED
1433
+ - RESERVED
1434
+ - COMMITTED
1435
+ - ABORTED
1436
+ description: >-
1437
+ Below are the allowed values for the enumeration.
1438
+
1439
+ - RECEIVED - Next ledger has received the
1440
+ transfer.
1441
+
1442
+ - RESERVED - Next ledger has reserved the
1443
+ transfer.
1444
+
1445
+ - COMMITTED - Next ledger has successfully
1446
+ performed the transfer.
1447
+
1448
+ - ABORTED - Next ledger has aborted the transfer
1449
+ due to a rejection or failure to perform the
1450
+ transfer.
1451
+ example: RESERVED
1452
+ extensionList:
1453
+ title: ExtensionList
1454
+ type: object
1455
+ description: >-
1456
+ Data model for the complex type ExtensionList. An
1457
+ optional list of extensions, specific to
1458
+ deployment.
1459
+ properties: *ref_11
1460
+ required: *ref_12
1461
+ required: &ref_101
1462
+ - transferState
1463
+ quoteExtensions:
1464
+ title: ExtensionList
1465
+ type: object
1466
+ description: >-
1467
+ Data model for the complex type ExtensionList. An
1468
+ optional list of extensions, specific to deployment.
1469
+ properties: *ref_11
1470
+ required: *ref_12
1471
+ transferExtensions:
1472
+ title: ExtensionList
1473
+ type: object
1474
+ description: >-
1475
+ Data model for the complex type ExtensionList. An
1476
+ optional list of extensions, specific to deployment.
1477
+ properties: *ref_11
1478
+ required: *ref_12
1479
+ lastError:
1480
+ type: object
1481
+ description: >-
1482
+ This object represents a Mojaloop API error received
1483
+ at any time during the transfer process
1484
+ properties: &ref_32
1485
+ httpStatusCode:
1486
+ type: integer
1487
+ description: >-
1488
+ The HTTP status code returned to the caller. This
1489
+ is the same as the actual HTTP status code
1490
+ returned with the response.
1491
+ mojaloopError:
1492
+ description: >-
1493
+ If a transfer process results in an error callback
1494
+ during the asynchronous Mojaloop API exchange,
1495
+ this property will contain the underlying Mojaloop
1496
+ API error object.
1497
+ type: object
1498
+ properties: &ref_104
1499
+ errorInformation:
1500
+ title: ErrorInformation
1501
+ type: object
1502
+ description: >-
1503
+ Data model for the complex type
1504
+ ErrorInformation.
1505
+ properties: &ref_102
1506
+ errorCode:
1507
+ title: ErrorCode
1508
+ type: string
1509
+ pattern: ^[1-9]\d{3}$
1510
+ description: >-
1511
+ The API data type ErrorCode is a JSON
1512
+ String of four characters, consisting of
1513
+ digits only. Negative numbers are not
1514
+ allowed. A leading zero is not allowed.
1515
+ Each error code in the API is a four-digit
1516
+ number, for example, 1234, where the first
1517
+ number (1 in the example) represents the
1518
+ high-level error category, the second
1519
+ number (2 in the example) represents the
1520
+ low-level error category, and the last two
1521
+ numbers (34 in the example) represent the
1522
+ specific error.
1523
+ example: '5100'
1524
+ errorDescription:
1525
+ title: ErrorDescription
1526
+ type: string
1527
+ minLength: 1
1528
+ maxLength: 128
1529
+ description: Error description string.
1530
+ extensionList:
1531
+ title: ExtensionList
1532
+ type: object
1533
+ description: >-
1534
+ Data model for the complex type
1535
+ ExtensionList. An optional list of
1536
+ extensions, specific to deployment.
1537
+ properties: *ref_11
1538
+ required: *ref_12
1539
+ required: &ref_103
1540
+ - errorCode
1541
+ - errorDescription
1542
+ extensions:
1543
+ title: ExtensionList
1544
+ type: object
1545
+ description: >-
1546
+ Data model for the complex type ExtensionList. An optional
1547
+ list of extensions, specific to deployment.
1548
+ properties: *ref_11
1549
+ required: *ref_12
647
1550
  responses:
648
1551
  '202':
649
1552
  description: Bulk transaction information successfully amended.
@@ -663,7 +1566,7 @@ paths:
663
1566
  content:
664
1567
  application/json:
665
1568
  schema:
666
- properties: &ref_55
1569
+ properties: &ref_49
667
1570
  bulkQuote:
668
1571
  description: A response to a request for a bulk quote.
669
1572
  properties: *ref_4
@@ -683,12 +1586,12 @@ paths:
683
1586
  description: >-
684
1587
  Data model for individual transfer in a bulk transfer
685
1588
  request.
686
- properties: &ref_42
1589
+ properties: &ref_41
687
1590
  amount:
688
1591
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
689
1592
  type: string
690
1593
  amountType:
691
- enum: *ref_8
1594
+ enum: *ref_13
692
1595
  type: string
693
1596
  currency:
694
1597
  enum: *ref_0
@@ -704,10 +1607,10 @@ paths:
704
1607
  minLength: 3
705
1608
  type: string
706
1609
  initiator:
707
- enum: *ref_9
1610
+ enum: *ref_14
708
1611
  type: string
709
1612
  initiatorType:
710
- enum: *ref_10
1613
+ enum: *ref_15
711
1614
  type: string
712
1615
  note:
713
1616
  description: An optional note associated with the quote.
@@ -728,14 +1631,14 @@ paths:
728
1631
  required: *ref_2
729
1632
  type: object
730
1633
  transactionType:
731
- enum: *ref_11
1634
+ enum: *ref_16
732
1635
  type: string
733
1636
  transferId:
734
1637
  description: A Mojaloop API transfer identifier (UUID).
735
1638
  pattern: >-
736
1639
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
737
1640
  type: string
738
- required: &ref_43
1641
+ required: &ref_42
739
1642
  - transferId
740
1643
  - amount
741
1644
  - currency
@@ -743,7 +1646,7 @@ paths:
743
1646
  maxItems: 1000
744
1647
  minItems: 1
745
1648
  type: array
746
- required: &ref_56
1649
+ required: &ref_50
747
1650
  - bulkTransferId
748
1651
  - individualTransfers
749
1652
  type: object
@@ -753,7 +1656,7 @@ paths:
753
1656
  content:
754
1657
  application/json:
755
1658
  schema:
756
- properties: &ref_14
1659
+ properties: &ref_19
757
1660
  bulkTransferId:
758
1661
  description: A Mojaloop API transfer identifier (UUID).
759
1662
  pattern: >-
@@ -769,12 +1672,12 @@ paths:
769
1672
  description: >-
770
1673
  Data model for individual transfer in a bulk transfer
771
1674
  response.
772
- properties: &ref_44
1675
+ properties: &ref_43
773
1676
  errorResponse:
774
1677
  properties: *ref_3
775
1678
  type: object
776
1679
  extensionList:
777
- items: *ref_12
1680
+ items: *ref_17
778
1681
  maxItems: 16
779
1682
  minItems: 0
780
1683
  type: array
@@ -783,13 +1686,13 @@ paths:
783
1686
  pattern: >-
784
1687
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
785
1688
  type: string
786
- required: &ref_45
1689
+ required: &ref_44
787
1690
  - transferId
788
1691
  type: object
789
1692
  maxItems: 1000
790
1693
  minItems: 1
791
1694
  type: array
792
- required: &ref_15
1695
+ required: &ref_20
793
1696
  - homeTransactionId
794
1697
  type: object
795
1698
  description: The bulk transfer was accepted.
@@ -812,14 +1715,14 @@ paths:
812
1715
  in: path
813
1716
  name: idValue
814
1717
  required: true
815
- schema: *ref_13
1718
+ schema: *ref_18
816
1719
  responses:
817
1720
  '200':
818
1721
  content:
819
1722
  application/json:
820
1723
  schema:
821
- properties: *ref_14
822
- required: *ref_15
1724
+ properties: *ref_19
1725
+ required: *ref_20
823
1726
  type: object
824
1727
  description: Response containing details of the requested bulk transfer.
825
1728
  '400':
@@ -844,7 +1747,7 @@ paths:
844
1747
  - in: path
845
1748
  name: requestToPayId
846
1749
  required: true
847
- schema: &ref_31
1750
+ schema: &ref_33
848
1751
  maxLength: 128
849
1752
  minLength: 1
850
1753
  type: string
@@ -853,11 +1756,11 @@ paths:
853
1756
  content:
854
1757
  application/json:
855
1758
  schema:
856
- properties: &ref_65
1759
+ properties: &ref_58
857
1760
  otpValue:
858
1761
  description: OTP value.
859
1762
  type: string
860
- required: &ref_66
1763
+ required: &ref_59
861
1764
  - otpValue
862
1765
  type: object
863
1766
  description: Response containing details of the OTP.
@@ -888,19 +1791,19 @@ paths:
888
1791
  in: path
889
1792
  name: idType
890
1793
  required: true
891
- schema: &ref_16
1794
+ schema: &ref_21
892
1795
  type: string
893
1796
  - description: The identifier value.
894
1797
  in: path
895
1798
  name: idValue
896
1799
  required: true
897
- schema: *ref_13
1800
+ schema: *ref_18
898
1801
  responses:
899
1802
  '200':
900
1803
  content:
901
1804
  application/json:
902
1805
  schema:
903
- properties: &ref_17
1806
+ properties: &ref_22
904
1807
  fspId:
905
1808
  description: FSP identifier.
906
1809
  maxLength: 32
@@ -937,26 +1840,26 @@ paths:
937
1840
  in: path
938
1841
  name: idType
939
1842
  required: true
940
- schema: *ref_16
1843
+ schema: *ref_21
941
1844
  - description: The identifier value.
942
1845
  in: path
943
1846
  name: idValue
944
1847
  required: true
945
- schema: *ref_13
1848
+ schema: *ref_18
946
1849
  - description: >-
947
1850
  A sub-identifier of the party identifier, or a sub-type of the party
948
1851
  identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
949
1852
  in: path
950
1853
  name: idSubValue
951
1854
  required: true
952
- schema: &ref_18
1855
+ schema: &ref_23
953
1856
  type: string
954
1857
  responses:
955
1858
  '200':
956
1859
  content:
957
1860
  application/json:
958
1861
  schema:
959
- properties: *ref_17
1862
+ properties: *ref_22
960
1863
  type: object
961
1864
  description: Response containing details of the requested party.
962
1865
  '400':
@@ -988,12 +1891,12 @@ paths:
988
1891
  in: path
989
1892
  name: idType
990
1893
  required: true
991
- schema: *ref_16
1894
+ schema: *ref_21
992
1895
  - description: The identifier value.
993
1896
  in: path
994
1897
  name: idValue
995
1898
  required: true
996
- schema: *ref_13
1899
+ schema: *ref_18
997
1900
  responses:
998
1901
  '200':
999
1902
  content:
@@ -1032,19 +1935,19 @@ paths:
1032
1935
  in: path
1033
1936
  name: idType
1034
1937
  required: true
1035
- schema: *ref_16
1938
+ schema: *ref_21
1036
1939
  - description: The identifier value.
1037
1940
  in: path
1038
1941
  name: idValue
1039
1942
  required: true
1040
- schema: *ref_13
1943
+ schema: *ref_18
1041
1944
  - description: >-
1042
1945
  A sub-identifier of the party identifier, or a sub-type of the party
1043
1946
  identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
1044
1947
  in: path
1045
1948
  name: idSubValue
1046
1949
  required: true
1047
- schema: *ref_18
1950
+ schema: *ref_23
1048
1951
  responses:
1049
1952
  '200':
1050
1953
  content:
@@ -1080,7 +1983,7 @@ paths:
1080
1983
  application/json:
1081
1984
  schema:
1082
1985
  description: A request for a quote for transfer from the DFSP backend.
1083
- properties: &ref_67
1986
+ properties: &ref_61
1084
1987
  amount:
1085
1988
  description: >-
1086
1989
  Depending on `amountType`. If SEND - The amount the Payer
@@ -1095,7 +1998,7 @@ paths:
1095
1998
  type: string
1096
1999
  amountType:
1097
2000
  description: SEND for send amount, RECEIVE for receive amount.
1098
- enum: *ref_8
2001
+ enum: *ref_13
1099
2002
  type: string
1100
2003
  currency:
1101
2004
  enum: *ref_0
@@ -1108,7 +2011,7 @@ paths:
1108
2011
  ^(?:[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)$
1109
2012
  type: string
1110
2013
  extensionList:
1111
- items: *ref_12
2014
+ items: *ref_17
1112
2015
  maxItems: 16
1113
2016
  minItems: 0
1114
2017
  type: array
@@ -1135,18 +2038,18 @@ paths:
1135
2038
  description: >-
1136
2039
  Indicates the geographic location from where the transaction
1137
2040
  was initiated.
1138
- properties: *ref_19
1139
- required: *ref_20
2041
+ properties: *ref_24
2042
+ required: *ref_25
1140
2043
  type: object
1141
2044
  initiator:
1142
2045
  description: >-
1143
2046
  Specifies if the initiator of the transfer is the Payer or
1144
2047
  Payee.
1145
- enum: *ref_9
2048
+ enum: *ref_14
1146
2049
  type: string
1147
2050
  initiatorType:
1148
2051
  description: Specifies the type of the transaction initiator.
1149
- enum: *ref_10
2052
+ enum: *ref_15
1150
2053
  type: string
1151
2054
  note:
1152
2055
  description: An optional note associated with the requested transfer.
@@ -1183,9 +2086,9 @@ paths:
1183
2086
  type: string
1184
2087
  transactionType:
1185
2088
  description: Type of transaction for which the quote is requested.
1186
- enum: *ref_11
2089
+ enum: *ref_16
1187
2090
  type: string
1188
- required: &ref_68
2091
+ required: &ref_62
1189
2092
  - quoteId
1190
2093
  - transactionId
1191
2094
  - to
@@ -1204,14 +2107,14 @@ paths:
1204
2107
  application/json:
1205
2108
  schema:
1206
2109
  description: A response to a request for a quote.
1207
- properties: &ref_25
2110
+ properties: &ref_28
1208
2111
  expiration:
1209
2112
  description: An ISO-8601 formatted timestamp.
1210
2113
  pattern: >-
1211
2114
  ^(?:[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)$
1212
2115
  type: string
1213
2116
  extensionList:
1214
- items: *ref_12
2117
+ items: *ref_17
1215
2118
  maxItems: 16
1216
2119
  minItems: 0
1217
2120
  type: array
@@ -1219,8 +2122,8 @@ paths:
1219
2122
  description: >-
1220
2123
  Indicates the geographic location from where the
1221
2124
  transaction was initiated.
1222
- properties: *ref_19
1223
- required: *ref_20
2125
+ properties: *ref_24
2126
+ required: *ref_25
1224
2127
  type: object
1225
2128
  payeeFspCommissionAmount:
1226
2129
  description: Transaction commission from the Payee FSP.
@@ -1279,7 +2182,7 @@ paths:
1279
2182
  maxLength: 3
1280
2183
  minLength: 3
1281
2184
  type: string
1282
- required: &ref_26
2185
+ required: &ref_29
1283
2186
  - quoteId
1284
2187
  - transactionId
1285
2188
  - transferAmount
@@ -1303,7 +2206,7 @@ paths:
1303
2206
  application/json:
1304
2207
  schema:
1305
2208
  description: A request for a pull based transfer.
1306
- properties: &ref_70
2209
+ properties: &ref_64
1307
2210
  amount:
1308
2211
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1309
2212
  type: string
@@ -1325,14 +2228,14 @@ paths:
1325
2228
  description: >-
1326
2229
  Indicates the geographic location from where the transaction
1327
2230
  was initiated.
1328
- properties: *ref_19
1329
- required: *ref_20
2231
+ properties: *ref_24
2232
+ required: *ref_25
1330
2233
  type: object
1331
2234
  initiator:
1332
- enum: *ref_9
2235
+ enum: *ref_14
1333
2236
  type: string
1334
2237
  initiatorType:
1335
- enum: *ref_10
2238
+ enum: *ref_15
1336
2239
  type: string
1337
2240
  note:
1338
2241
  description: An optional note associated with the requested transfer.
@@ -1349,7 +2252,7 @@ paths:
1349
2252
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1350
2253
  type: string
1351
2254
  transactionType:
1352
- enum: *ref_11
2255
+ enum: *ref_16
1353
2256
  type: string
1354
2257
  subScenario:
1355
2258
  description: >-
@@ -1360,7 +2263,7 @@ paths:
1360
2263
  pattern: ^[A-Z_]{1,32}$
1361
2264
  title: transactionSubScenario
1362
2265
  type: string
1363
- required: &ref_71
2266
+ required: &ref_65
1364
2267
  - transactionRequestId
1365
2268
  - to
1366
2269
  - from
@@ -1377,7 +2280,7 @@ paths:
1377
2280
  application/json:
1378
2281
  schema:
1379
2282
  description: A response to a request for a quote.
1380
- properties: &ref_72
2283
+ properties: &ref_66
1381
2284
  transactionId:
1382
2285
  description: >-
1383
2286
  ID of the transaction, the ID is decided by the Payer FSP
@@ -1386,13 +2289,13 @@ paths:
1386
2289
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1387
2290
  type: string
1388
2291
  transferAmount:
1389
- enum: &ref_74
2292
+ enum: &ref_68
1390
2293
  - RECEIVED
1391
2294
  - PENDING
1392
2295
  - ACCEPTED
1393
2296
  - REJECTED
1394
2297
  type: string
1395
- required: &ref_73
2298
+ required: &ref_67
1396
2299
  - transactionId
1397
2300
  - transactionRequestState
1398
2301
  type: object
@@ -1416,12 +2319,12 @@ paths:
1416
2319
  content:
1417
2320
  application/json:
1418
2321
  schema:
1419
- properties: &ref_80
2322
+ properties: &ref_73
1420
2323
  amount:
1421
2324
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1422
2325
  type: string
1423
2326
  amountType:
1424
- enum: *ref_8
2327
+ enum: *ref_13
1425
2328
  type: string
1426
2329
  currency:
1427
2330
  enum: *ref_0
@@ -1436,12 +2339,12 @@ paths:
1436
2339
  properties:
1437
2340
  data:
1438
2341
  description: Object containing transfer object.
1439
- properties: &ref_62
2342
+ properties: &ref_56
1440
2343
  amount:
1441
2344
  description: >-
1442
2345
  Object containing Amount and Currency of the
1443
2346
  transfer.
1444
- properties: &ref_51
2347
+ properties: &ref_45
1445
2348
  amount:
1446
2349
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1447
2350
  type: string
@@ -1450,303 +2353,22 @@ paths:
1450
2353
  maxLength: 3
1451
2354
  minLength: 3
1452
2355
  type: string
1453
- required: &ref_52
2356
+ required: &ref_46
1454
2357
  - amount
1455
2358
  - currency
1456
2359
  type: object
1457
2360
  payee:
1458
2361
  description: Data model for the complex type Party.
1459
- properties: &ref_23
1460
- merchantClassificationCode:
1461
- description: >-
1462
- A limited set of pre-defined numbers. This list
1463
- would be a limited set of numbers identifying a
1464
- set of popular merchant types like School Fees,
1465
- Pubs and Restaurants, Groceries, etc.
1466
- pattern: ^[\d]{1,4}$
1467
- title: MerchantClassificationCode
1468
- type: string
1469
- name:
1470
- description: >-
1471
- Name of the Party. Could be a real name or a
1472
- nickname.
1473
- maxLength: 128
1474
- minLength: 1
1475
- title: PartyName
1476
- type: string
1477
- partyIdInfo:
1478
- description: Data model for the complex type PartyIdInfo.
1479
- properties: &ref_47
1480
- extensionList:
1481
- description: >-
1482
- Data model for the complex type
1483
- ExtensionList
1484
- properties: &ref_34
1485
- extension:
1486
- description: Number of Extension elements
1487
- items:
1488
- description: >-
1489
- Data model for the complex type
1490
- Extension
1491
- properties: &ref_32
1492
- key:
1493
- description: Extension key.
1494
- maxLength: 32
1495
- minLength: 1
1496
- title: ExtensionKey
1497
- type: string
1498
- value:
1499
- description: Extension value.
1500
- maxLength: 128
1501
- minLength: 1
1502
- title: ExtensionValue
1503
- type: string
1504
- required: &ref_33
1505
- - key
1506
- - value
1507
- title: Extension
1508
- type: object
1509
- maxItems: 16
1510
- minItems: 1
1511
- type: array
1512
- required: &ref_35
1513
- - extension
1514
- title: ExtensionList
1515
- type: object
1516
- fspId:
1517
- description: FSP identifier.
1518
- maxLength: 32
1519
- minLength: 1
1520
- title: FspId
1521
- type: string
1522
- partyIdType:
1523
- description: >
1524
- This is a variant based on FSPIOP
1525
- `PartyIdType` specification.
1526
-
1527
- Main difference being the CONSENT and
1528
- THIRD_PARTY_LINK enums.
1529
-
1530
-
1531
- Below are the allowed values for the
1532
- enumeration.
1533
-
1534
- - MSISDN - An MSISDN (Mobile Station
1535
- International Subscriber Directory
1536
-
1537
- Number, that is, the phone number) is used
1538
- as reference to a participant.
1539
-
1540
- The MSISDN identifier should be in
1541
- international format according to the
1542
-
1543
- [ITU-T E.164
1544
- standard](https://www.itu.int/rec/T-REC-E.164/en).
1545
-
1546
- Optionally, the MSISDN may be prefixed by a
1547
- single plus sign, indicating the
1548
-
1549
- international prefix.
1550
-
1551
- - EMAIL - An email is used as reference to a
1552
-
1553
- participant. The format of the email should
1554
- be according to the informational
1555
-
1556
- [RFC
1557
- 3696](https://tools.ietf.org/html/rfc3696).
1558
-
1559
- - PERSONAL_ID - A personal identifier is
1560
- used as reference to a participant.
1561
-
1562
- Examples of personal identification are
1563
- passport number, birth certificate
1564
-
1565
- number, and national registration number.
1566
- The identifier number is added in
1567
-
1568
- the PartyIdentifier element. The personal
1569
- identifier type is added in the
1570
-
1571
- PartySubIdOrType element.
1572
-
1573
- - BUSINESS - A specific Business (for
1574
- example, an organization or a company)
1575
-
1576
- is used as reference to a participant. The
1577
- BUSINESS identifier can be in any
1578
-
1579
- format. To make a transaction connected to a
1580
- specific username or bill number
1581
-
1582
- in a Business, the PartySubIdOrType element
1583
- should be used.
1584
-
1585
- - DEVICE - A specific device (for example, a
1586
- POS or ATM) ID connected to a
1587
-
1588
- specific business or organization is used as
1589
- reference to a Party.
1590
-
1591
- For referencing a specific device under a
1592
- specific business or organization,
1593
-
1594
- use the PartySubIdOrType element.
1595
-
1596
- - ACCOUNT_ID - A bank account number or FSP
1597
- account ID should be used as
1598
-
1599
- reference to a participant. The ACCOUNT_ID
1600
- identifier can be in any format,
1601
-
1602
- as formats can greatly differ depending on
1603
- country and FSP.
1604
-
1605
- - IBAN - A bank account number or FSP
1606
- account ID is used as reference to a
1607
-
1608
- participant. The IBAN identifier can consist
1609
- of up to 34 alphanumeric
1610
-
1611
- characters and should be entered without
1612
- whitespace.
1613
-
1614
- - ALIAS An alias is used as reference to a
1615
- participant. The alias should be
1616
-
1617
- created in the FSP as an alternative
1618
- reference to an account owner.
1619
-
1620
- Another example of an alias is a username in
1621
- the FSP system.
1622
-
1623
- The ALIAS identifier can be in any format.
1624
- It is also possible to use the
1625
-
1626
- PartySubIdOrType element for identifying an
1627
- account under an Alias defined
1628
-
1629
- by the PartyIdentifier.
1630
-
1631
- - CONSENT - TBD
1632
-
1633
- - THIRD_PARTY_LINK - TBD
1634
- enum: &ref_49
1635
- - MSISDN
1636
- - EMAIL
1637
- - PERSONAL_ID
1638
- - BUSINESS
1639
- - DEVICE
1640
- - ACCOUNT_ID
1641
- - IBAN
1642
- - ALIAS
1643
- - CONSENT
1644
- - THIRD_PARTY_LINK
1645
- example: PERSONAL_ID
1646
- title: PartyIdType
1647
- type: string
1648
- partyIdentifier:
1649
- description: Identifier of the Party.
1650
- example: '16135551212'
1651
- maxLength: 128
1652
- minLength: 1
1653
- title: PartyIdentifier
1654
- type: string
1655
- partySubIdOrType:
1656
- description: >-
1657
- Either a sub-identifier of a
1658
- PartyIdentifier, or a sub-type of the
1659
- PartyIdType, normally a
1660
- PersonalIdentifierType.
1661
- maxLength: 128
1662
- minLength: 1
1663
- title: PartySubIdOrType
1664
- type: string
1665
- required: &ref_48
1666
- - partyIdType
1667
- - partyIdentifier
1668
- title: PartyIdInfo
1669
- type: object
1670
- personalInfo:
1671
- description: >-
1672
- Data model for the complex type
1673
- PartyPersonalInfo.
1674
- properties: &ref_50
1675
- complexName:
1676
- description: >-
1677
- Data model for the complex type
1678
- PartyComplexName.
1679
- properties: &ref_46
1680
- displayName:
1681
- description: Display name of the sender if known
1682
- type: string
1683
- firstName:
1684
- description: First name of the Party (Name Type).
1685
- example: Henrik
1686
- maxLength: 128
1687
- minLength: 1
1688
- pattern: >-
1689
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1690
- .,''-]{1,128}$
1691
- title: FirstName
1692
- type: string
1693
- idSubValue:
1694
- description: >-
1695
- The sub identifier string used to
1696
- identify the sender
1697
- type: string
1698
- idType:
1699
- enum: *ref_21
1700
- type: string
1701
- idValue:
1702
- description: >-
1703
- The identifier string used to identify
1704
- the sender
1705
- type: string
1706
- lastName:
1707
- description: Last name of the Party (Name Type).
1708
- example: Karlsson
1709
- maxLength: 128
1710
- minLength: 1
1711
- pattern: >-
1712
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1713
- .,''-]{1,128}$
1714
- title: LastName
1715
- type: string
1716
- middleName:
1717
- description: Middle name of the Party (Name Type).
1718
- example: Johannes
1719
- maxLength: 128
1720
- minLength: 1
1721
- pattern: >-
1722
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
1723
- .,''-]{1,128}$
1724
- title: MiddleName
1725
- type: string
1726
- type:
1727
- enum: *ref_22
1728
- type: string
1729
- title: PartyComplexName
1730
- type: object
1731
- dateOfBirth:
1732
- description: Date of Birth of the Party.
1733
- example: '1966-06-16'
1734
- pattern: >-
1735
- ^(?:[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)$
1736
- title: DateofBirth (type Date)
1737
- type: string
1738
- title: PartyPersonalInfo
1739
- type: object
1740
- required: &ref_24
1741
- - partyIdInfo
1742
2362
  title: Party
1743
2363
  type: object
2364
+ properties: *ref_26
2365
+ required: *ref_27
1744
2366
  payer:
1745
2367
  description: Data model for the complex type Party.
1746
- properties: *ref_23
1747
- required: *ref_24
1748
2368
  title: Party
1749
2369
  type: object
2370
+ properties: *ref_26
2371
+ required: *ref_27
1750
2372
  quoteId:
1751
2373
  description: A Mojaloop API quote identifier (UUID).
1752
2374
  pattern: >-
@@ -1761,16 +2383,16 @@ paths:
1761
2383
  type: string
1762
2384
  transactionType:
1763
2385
  description: Object containing transfer object.
1764
- properties: &ref_75
2386
+ properties: &ref_69
1765
2387
  initiator:
1766
- enum: *ref_9
2388
+ enum: *ref_14
1767
2389
  type: string
1768
2390
  initiatorType:
1769
2391
  description: Specifies the type of the transaction initiator.
1770
- enum: *ref_10
2392
+ enum: *ref_15
1771
2393
  type: string
1772
2394
  scenario:
1773
- enum: &ref_69
2395
+ enum: &ref_63
1774
2396
  - TRANSFER
1775
2397
  type: string
1776
2398
  subScenario:
@@ -1782,12 +2404,12 @@ paths:
1782
2404
  pattern: ^[A-Z_]{1,32}$
1783
2405
  title: transactionSubScenario
1784
2406
  type: string
1785
- required: &ref_76
2407
+ required: &ref_70
1786
2408
  - scenario
1787
2409
  - initiator
1788
2410
  - initiatorType
1789
2411
  type: object
1790
- required: &ref_63
2412
+ required: &ref_57
1791
2413
  - quoteId
1792
2414
  - transactionId
1793
2415
  - payer
@@ -1803,11 +2425,11 @@ paths:
1803
2425
  type: string
1804
2426
  quote:
1805
2427
  description: A response to a request for a quote.
1806
- properties: *ref_25
1807
- required: *ref_26
2428
+ properties: *ref_28
2429
+ required: *ref_29
1808
2430
  type: object
1809
2431
  quoteRequestExtensions:
1810
- items: *ref_12
2432
+ items: *ref_17
1811
2433
  maxItems: 16
1812
2434
  minItems: 0
1813
2435
  type: array
@@ -1825,14 +2447,14 @@ paths:
1825
2447
  required: *ref_2
1826
2448
  type: object
1827
2449
  transactionType:
1828
- enum: *ref_11
2450
+ enum: *ref_16
1829
2451
  type: string
1830
2452
  transferId:
1831
2453
  description: A Mojaloop API transfer identifier (UUID).
1832
2454
  pattern: >-
1833
2455
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1834
2456
  type: string
1835
- required: &ref_81
2457
+ required: &ref_74
1836
2458
  - transferId
1837
2459
  - quote
1838
2460
  - from
@@ -1849,7 +2471,7 @@ paths:
1849
2471
  content:
1850
2472
  application/json:
1851
2473
  schema:
1852
- properties: &ref_82
2474
+ properties: &ref_75
1853
2475
  completedTimestamp:
1854
2476
  description: An ISO-8601 formatted timestamp.
1855
2477
  example: '2020-05-19T08:38:08.699-04:00'
@@ -1860,11 +2482,11 @@ paths:
1860
2482
  description: >-
1861
2483
  Fulfilment that must be attached to the transfer by the
1862
2484
  Payee.
1863
- example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
1864
- maxLength: 48
1865
- pattern: ^[A-Za-z0-9-_]{43}$
1866
- title: ilpFulfilment
2485
+ title: IlpFulfilment
1867
2486
  type: string
2487
+ pattern: ^[A-Za-z0-9-_]{43}$
2488
+ maxLength: 48
2489
+ example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
1868
2490
  homeTransactionId:
1869
2491
  description: >-
1870
2492
  Transaction ID from the DFSP backend, used to reconcile
@@ -1879,13 +2501,13 @@ paths:
1879
2501
  aborted the transfer due a rejection or failure to perform
1880
2502
  the transfer.
1881
2503
  example: ABORTED
1882
- enum: &ref_27
2504
+ enum: &ref_30
1883
2505
  - RECEIVED
1884
2506
  - RESERVED
1885
2507
  - COMMITTED
1886
2508
  - ABORTED
1887
2509
  type: string
1888
- required: &ref_83
2510
+ required: &ref_76
1889
2511
  - homeTransactionId
1890
2512
  type: object
1891
2513
  description: The transfer was accepted.
@@ -1910,19 +2532,19 @@ paths:
1910
2532
  - in: path
1911
2533
  name: transferId
1912
2534
  required: true
1913
- schema: &ref_28
2535
+ schema: &ref_31
1914
2536
  type: string
1915
2537
  responses:
1916
2538
  '200':
1917
2539
  content:
1918
2540
  application/json:
1919
2541
  schema:
1920
- properties: &ref_77
2542
+ properties: &ref_71
1921
2543
  amount:
1922
2544
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1923
2545
  type: string
1924
2546
  amountType:
1925
- enum: *ref_8
2547
+ enum: *ref_13
1926
2548
  type: string
1927
2549
  currency:
1928
2550
  enum: *ref_0
@@ -1930,7 +2552,7 @@ paths:
1930
2552
  minLength: 3
1931
2553
  type: string
1932
2554
  extensions:
1933
- items: *ref_12
2555
+ items: *ref_17
1934
2556
  maxItems: 16
1935
2557
  minItems: 0
1936
2558
  type: array
@@ -1965,7 +2587,7 @@ paths:
1965
2587
  required: *ref_2
1966
2588
  type: object
1967
2589
  transactionType:
1968
- enum: *ref_11
2590
+ enum: *ref_16
1969
2591
  type: string
1970
2592
  transferState:
1971
2593
  description: >
@@ -1975,9 +2597,9 @@ paths:
1975
2597
  successfully performed the transfer. - ABORTED DFSP has
1976
2598
  aborted the transfer due a rejection or failure to perform
1977
2599
  the transfer.
1978
- enum: *ref_27
2600
+ enum: *ref_30
1979
2601
  type: string
1980
- required: &ref_78
2602
+ required: &ref_72
1981
2603
  - homeTransactionId
1982
2604
  - from
1983
2605
  - to
@@ -2004,15 +2626,15 @@ paths:
2004
2626
  - in: path
2005
2627
  name: transferId
2006
2628
  required: true
2007
- schema: *ref_28
2629
+ schema: *ref_31
2008
2630
  requestBody:
2009
2631
  content:
2010
2632
  application/json:
2011
2633
  schema:
2012
2634
  description: PUT /transfers/{transferId} object.
2013
- properties: &ref_61
2635
+ properties: &ref_54
2014
2636
  currentState:
2015
- enum: &ref_84
2637
+ enum: &ref_77
2016
2638
  - ERROR_OCCURRED
2017
2639
  - WAITING_FOR_PARTY_ACCEPTANCE
2018
2640
  - WAITING_FOR_QUOTE_ACCEPTANCE
@@ -2032,7 +2654,7 @@ paths:
2032
2654
  type: string
2033
2655
  extensionList:
2034
2656
  description: Optional extension, specific to deployment.
2035
- items: *ref_12
2657
+ items: *ref_17
2036
2658
  maxItems: 16
2037
2659
  minItems: 0
2038
2660
  type: array
@@ -2045,7 +2667,7 @@ paths:
2045
2667
  aborted the transfer due a rejection or failure to
2046
2668
  perform the transfer.
2047
2669
  example: COMMITTED
2048
- enum: *ref_27
2670
+ enum: *ref_30
2049
2671
  type: string
2050
2672
  required:
2051
2673
  - completedTimestamp
@@ -2064,68 +2686,11 @@ paths:
2064
2686
  ^(?:[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)$
2065
2687
  type: string
2066
2688
  lastError:
2689
+ type: object
2067
2690
  description: >-
2068
2691
  This object represents a Mojaloop API error received at any
2069
- time during the transfer process.
2070
- properties: &ref_79
2071
- httpStatusCode:
2072
- description: >-
2073
- The HTTP status code returned to the caller. This is the
2074
- same as the actual HTTP status code returned with the
2075
- response.
2076
- type: integer
2077
- mojaloopError:
2078
- description: >-
2079
- If a transfer process results in an error callback
2080
- during the asynchronous Mojaloop API exchange, this
2081
- property will contain the underlying Mojaloop API error
2082
- object.
2083
- properties: &ref_64
2084
- errorInformation:
2085
- description: A Mojaloop API error information construct.
2086
- properties: &ref_57
2087
- errorCode:
2088
- description: >
2089
- The API data type errorCode is a JSON String of
2090
- four characters, consisting of digits only.
2091
- Negative numbers are not allowed. A leading zero
2092
- is not allowed. Each error code in the API is a
2093
- four-digit number, for example, 1234, where the
2094
- first number (1 in the example) represents the
2095
- high-level error category, the second number (2
2096
- in the example) represents the low-level error
2097
- category, and the last two numbers (34 in the
2098
- example) represents the specific error.
2099
- pattern: ^[1-9]\d{3}$
2100
- title: ErrorCode
2101
- type: string
2102
- errorDescription:
2103
- description: Error description string.
2104
- maxLength: 128
2105
- minLength: 1
2106
- title: ErrorDescription
2107
- type: string
2108
- extensionList:
2109
- description: Data model for the complex type ExtensionList.
2110
- properties: &ref_59
2111
- extension:
2112
- description: Number of Extension elements.
2113
- items:
2114
- properties: *ref_29
2115
- type: object
2116
- maxItems: 16
2117
- minItems: 1
2118
- type: array
2119
- required: &ref_60
2120
- - extension
2121
- type: object
2122
- required: &ref_58
2123
- - errorCode
2124
- - errorDescription
2125
- title: ErrorInformation
2126
- type: object
2127
- type: object
2128
- type: object
2692
+ time during the transfer process
2693
+ properties: *ref_32
2129
2694
  prepare:
2130
2695
  properties:
2131
2696
  body:
@@ -2179,12 +2744,6 @@ paths:
2179
2744
  - Transfers
2180
2745
  components:
2181
2746
  parameters:
2182
- bulkTransactionId:
2183
- description: Identifier of the bulk transaction to continue as returned in.
2184
- in: path
2185
- name: bulkTransactionId
2186
- required: true
2187
- schema: *ref_30
2188
2747
  idSubValue:
2189
2748
  description: >-
2190
2749
  A sub-identifier of the party identifier, or a sub-type of the party
@@ -2192,29 +2751,37 @@ components:
2192
2751
  in: path
2193
2752
  name: idSubValue
2194
2753
  required: true
2195
- schema: *ref_18
2754
+ schema: *ref_23
2196
2755
  idType:
2197
2756
  description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
2198
2757
  in: path
2199
2758
  name: idType
2200
2759
  required: true
2201
- schema: *ref_16
2760
+ schema: *ref_21
2202
2761
  idValue:
2203
2762
  description: The identifier value.
2204
2763
  in: path
2205
2764
  name: idValue
2206
2765
  required: true
2207
- schema: *ref_13
2766
+ schema: *ref_18
2208
2767
  requestToPayId:
2209
2768
  in: path
2210
2769
  name: requestToPayId
2211
2770
  required: true
2212
- schema: *ref_31
2771
+ schema: *ref_33
2213
2772
  transferId:
2214
2773
  in: path
2215
2774
  name: transferId
2216
2775
  required: true
2217
- schema: *ref_28
2776
+ schema: *ref_31
2777
+ bulkTransactionId:
2778
+ name: bulkTransactionId
2779
+ in: path
2780
+ required: true
2781
+ schema: *ref_34
2782
+ description: >-
2783
+ Identifier of the bulk transaction to continue as returned in the
2784
+ response to a `POST /bulkTransaction` request.
2218
2785
  responses:
2219
2786
  '400':
2220
2787
  content: *ref_6
@@ -2228,256 +2795,88 @@ components:
2228
2795
  description: An error occurred processing the request.
2229
2796
  schemas:
2230
2797
  DateOfBirth:
2231
- description: Date of Birth of the Party.
2232
- example: '1966-06-16'
2798
+ title: DateofBirth (type Date)
2799
+ type: string
2233
2800
  pattern: >-
2234
2801
  ^(?:[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)$
2235
- title: DateofBirth (type Date)
2802
+ description: Date of Birth of the Party.
2803
+ example: '1966-06-16'
2804
+ FirstName:
2805
+ title: FirstName
2236
2806
  type: string
2237
- Extension:
2238
- description: Data model for the complex type Extension
2239
- properties: *ref_32
2240
- required: *ref_33
2241
- title: Extension
2242
- type: object
2243
- ExtensionKey:
2244
- description: Extension key.
2245
- maxLength: 32
2246
2807
  minLength: 1
2247
- title: ExtensionKey
2248
- type: string
2249
- ExtensionList:
2250
- description: Data model for the complex type ExtensionList
2251
- properties: *ref_34
2252
- required: *ref_35
2253
- title: ExtensionList
2254
- type: object
2255
- ExtensionValue:
2256
- description: Extension value.
2257
2808
  maxLength: 128
2258
- minLength: 1
2259
- title: ExtensionValue
2260
- type: string
2261
- FirstName:
2262
- description: First name of the Party (Name Type).
2263
- example: Henrik
2264
- maxLength: 128
2265
- minLength: 1
2266
2809
  pattern: >-
2267
2810
  ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2268
2811
  .,''-]{1,128}$
2269
- title: FirstName
2270
- type: string
2812
+ description: First name of the Party (Name Type).
2813
+ example: Henrik
2271
2814
  FspId:
2272
- description: FSP identifier.
2273
- maxLength: 32
2274
- minLength: 1
2275
2815
  title: FspId
2276
2816
  type: string
2817
+ minLength: 1
2818
+ maxLength: 32
2819
+ description: FSP identifier.
2277
2820
  IndividualQuote:
2278
2821
  description: Data model for individual quote in a bulk quote request.
2279
- properties: *ref_36
2280
- required: *ref_37
2822
+ properties: *ref_35
2823
+ required: *ref_36
2281
2824
  type: object
2282
2825
  IndividualQuoteResultFailed:
2283
2826
  description: Data model for failed individual quote in a bulk quote response.
2284
- properties: *ref_38
2285
- required: *ref_39
2827
+ properties: *ref_37
2828
+ required: *ref_38
2286
2829
  type: object
2287
2830
  IndividualQuoteResultSuccess:
2288
2831
  description: Data model for successful individual quote in a bulk quote response.
2289
- properties: *ref_40
2290
- required: *ref_41
2832
+ properties: *ref_39
2833
+ required: *ref_40
2291
2834
  type: object
2292
2835
  IndividualTransfer:
2293
2836
  description: Data model for individual transfer in a bulk transfer request.
2294
- properties: *ref_42
2295
- required: *ref_43
2837
+ properties: *ref_41
2838
+ required: *ref_42
2296
2839
  type: object
2297
2840
  IndividualTransferResult:
2298
2841
  description: Data model for individual transfer in a bulk transfer response.
2299
- properties: *ref_44
2300
- required: *ref_45
2842
+ properties: *ref_43
2843
+ required: *ref_44
2301
2844
  type: object
2302
2845
  LastName:
2303
- description: Last name of the Party (Name Type).
2304
- example: Karlsson
2305
- maxLength: 128
2846
+ title: LastName
2847
+ type: string
2306
2848
  minLength: 1
2849
+ maxLength: 128
2307
2850
  pattern: >-
2308
2851
  ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2309
2852
  .,''-]{1,128}$
2310
- title: LastName
2311
- type: string
2853
+ description: Last name of the Party (Name Type).
2854
+ example: Karlsson
2312
2855
  MerchantClassificationCode:
2856
+ title: MerchantClassificationCode
2857
+ type: string
2858
+ pattern: ^[\d]{1,4}$
2313
2859
  description: >-
2314
2860
  A limited set of pre-defined numbers. This list would be a limited set
2315
2861
  of numbers identifying a set of popular merchant types like School Fees,
2316
2862
  Pubs and Restaurants, Groceries, etc.
2317
- pattern: ^[\d]{1,4}$
2318
- title: MerchantClassificationCode
2319
- type: string
2320
2863
  MiddleName:
2321
- description: Middle name of the Party (Name Type).
2322
- example: Johannes
2323
- maxLength: 128
2324
- minLength: 1
2325
- pattern: >-
2326
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2327
- .,''-]{1,128}$
2328
2864
  title: MiddleName
2329
2865
  type: string
2330
- Party:
2331
- description: Data model for the complex type Party.
2332
- properties: *ref_23
2333
- required: *ref_24
2334
- title: Party
2335
- type: object
2336
- PartyComplexName:
2337
- description: Data model for the complex type PartyComplexName.
2338
- properties: *ref_46
2339
- title: PartyComplexName
2340
- type: object
2341
- PartyIdInfo:
2342
- description: Data model for the complex type PartyIdInfo.
2343
- properties: *ref_47
2344
- required: *ref_48
2345
- title: PartyIdInfo
2346
- type: object
2347
- PartyIdType:
2348
- description: >
2349
- This is a variant based on FSPIOP `PartyIdType` specification.
2350
-
2351
- Main difference being the CONSENT and THIRD_PARTY_LINK enums.
2352
-
2353
-
2354
- Below are the allowed values for the enumeration.
2355
-
2356
- - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
2357
-
2358
- Number, that is, the phone number) is used as reference to a
2359
- participant.
2360
-
2361
- The MSISDN identifier should be in international format according to the
2362
-
2363
- [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
2364
-
2365
- Optionally, the MSISDN may be prefixed by a single plus sign, indicating
2366
- the
2367
-
2368
- international prefix.
2369
-
2370
- - EMAIL - An email is used as reference to a
2371
-
2372
- participant. The format of the email should be according to the
2373
- informational
2374
-
2375
- [RFC 3696](https://tools.ietf.org/html/rfc3696).
2376
-
2377
- - PERSONAL_ID - A personal identifier is used as reference to a
2378
- participant.
2379
-
2380
- Examples of personal identification are passport number, birth
2381
- certificate
2382
-
2383
- number, and national registration number. The identifier number is added
2384
- in
2385
-
2386
- the PartyIdentifier element. The personal identifier type is added in
2387
- the
2388
-
2389
- PartySubIdOrType element.
2390
-
2391
- - BUSINESS - A specific Business (for example, an organization or a
2392
- company)
2393
-
2394
- is used as reference to a participant. The BUSINESS identifier can be in
2395
- any
2396
-
2397
- format. To make a transaction connected to a specific username or bill
2398
- number
2399
-
2400
- in a Business, the PartySubIdOrType element should be used.
2401
-
2402
- - DEVICE - A specific device (for example, a POS or ATM) ID connected to
2403
- a
2404
-
2405
- specific business or organization is used as reference to a Party.
2406
-
2407
- For referencing a specific device under a specific business or
2408
- organization,
2409
-
2410
- use the PartySubIdOrType element.
2411
-
2412
- - ACCOUNT_ID - A bank account number or FSP account ID should be used as
2413
-
2414
- reference to a participant. The ACCOUNT_ID identifier can be in any
2415
- format,
2416
-
2417
- as formats can greatly differ depending on country and FSP.
2418
-
2419
- - IBAN - A bank account number or FSP account ID is used as reference to
2420
- a
2421
-
2422
- participant. The IBAN identifier can consist of up to 34 alphanumeric
2423
-
2424
- characters and should be entered without whitespace.
2425
-
2426
- - ALIAS An alias is used as reference to a participant. The alias should
2427
- be
2428
-
2429
- created in the FSP as an alternative reference to an account owner.
2430
-
2431
- Another example of an alias is a username in the FSP system.
2432
-
2433
- The ALIAS identifier can be in any format. It is also possible to use
2434
- the
2435
-
2436
- PartySubIdOrType element for identifying an account under an Alias
2437
- defined
2438
-
2439
- by the PartyIdentifier.
2440
-
2441
- - CONSENT - TBD
2442
-
2443
- - THIRD_PARTY_LINK - TBD
2444
- enum: *ref_49
2445
- example: PERSONAL_ID
2446
- title: PartyIdType
2447
- type: string
2448
- PartyIdentifier:
2449
- description: Identifier of the Party.
2450
- example: '16135551212'
2451
- maxLength: 128
2452
2866
  minLength: 1
2453
- title: PartyIdentifier
2454
- type: string
2455
- PartyName:
2456
- description: Name of the Party. Could be a real name or a nickname.
2457
- maxLength: 128
2458
- minLength: 1
2459
- title: PartyName
2460
- type: string
2461
- PartyPersonalInfo:
2462
- description: Data model for the complex type PartyPersonalInfo.
2463
- properties: *ref_50
2464
- title: PartyPersonalInfo
2465
- type: object
2466
- PartySubIdOrType:
2467
- description: >-
2468
- Either a sub-identifier of a PartyIdentifier, or a sub-type of the
2469
- PartyIdType, normally a PersonalIdentifierType.
2470
2867
  maxLength: 128
2471
- minLength: 1
2472
- title: PartySubIdOrType
2473
- type: string
2868
+ pattern: >-
2869
+ ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2870
+ .,''-]{1,128}$
2871
+ description: Middle name of the Party (Name Type).
2872
+ example: Johannes
2474
2873
  amountCurrency:
2475
2874
  description: Object containing Amount and Currency of the transfer.
2476
- properties: *ref_51
2477
- required: *ref_52
2875
+ properties: *ref_45
2876
+ required: *ref_46
2478
2877
  type: object
2479
2878
  amountType:
2480
- enum: *ref_8
2879
+ enum: *ref_13
2481
2880
  type: string
2482
2881
  bulkQuoteId:
2483
2882
  description: A Mojaloop API bulk quote identifier (UUID).
@@ -2486,8 +2885,8 @@ components:
2486
2885
  type: string
2487
2886
  bulkQuoteRequest:
2488
2887
  description: A request for a bulk quote.
2489
- properties: *ref_53
2490
- required: *ref_54
2888
+ properties: *ref_47
2889
+ required: *ref_48
2491
2890
  type: object
2492
2891
  bulkQuoteResponse:
2493
2892
  description: A response to a request for a bulk quote.
@@ -2500,12 +2899,12 @@ components:
2500
2899
  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2501
2900
  type: string
2502
2901
  bulkTransferRequest:
2503
- properties: *ref_55
2504
- required: *ref_56
2902
+ properties: *ref_49
2903
+ required: *ref_50
2505
2904
  type: object
2506
2905
  bulkTransferResponse:
2507
- properties: *ref_14
2508
- required: *ref_15
2906
+ properties: *ref_19
2907
+ required: *ref_20
2509
2908
  type: object
2510
2909
  currency:
2511
2910
  enum: *ref_0
@@ -2537,25 +2936,60 @@ components:
2537
2936
  type: string
2538
2937
  errorInformation:
2539
2938
  description: A Mojaloop API error information construct.
2540
- properties: *ref_57
2541
- required: *ref_58
2939
+ properties:
2940
+ errorCode:
2941
+ description: >
2942
+ The API data type errorCode is a JSON String of four characters,
2943
+ consisting of digits only. Negative numbers are not allowed. A
2944
+ leading zero is not allowed. Each error code in the API is a
2945
+ four-digit number, for example, 1234, where the first number (1 in
2946
+ the example) represents the high-level error category, the second
2947
+ number (2 in the example) represents the low-level error category,
2948
+ and the last two numbers (34 in the example) represents the specific
2949
+ error.
2950
+ pattern: ^[1-9]\d{3}$
2951
+ title: ErrorCode
2952
+ type: string
2953
+ errorDescription:
2954
+ description: Error description string.
2955
+ maxLength: 128
2956
+ minLength: 1
2957
+ title: ErrorDescription
2958
+ type: string
2959
+ extensionList:
2960
+ description: Data model for the complex type ExtensionList.
2961
+ properties: &ref_52
2962
+ extension:
2963
+ description: Number of Extension elements.
2964
+ items:
2965
+ properties: *ref_51
2966
+ type: object
2967
+ maxItems: 16
2968
+ minItems: 1
2969
+ type: array
2970
+ required: &ref_53
2971
+ - extension
2972
+ type: object
2973
+ required:
2974
+ - errorCode
2975
+ - errorDescription
2542
2976
  title: ErrorInformation
2543
2977
  type: object
2544
2978
  errorResponse:
2545
2979
  properties: *ref_3
2546
2980
  type: object
2547
2981
  extensionItem:
2548
- properties: *ref_29
2982
+ properties: *ref_51
2549
2983
  type: object
2550
2984
  extensionList:
2551
- items: *ref_12
2985
+ items: *ref_17
2552
2986
  maxItems: 16
2553
2987
  minItems: 0
2554
2988
  type: array
2555
2989
  extensionListComplex:
2556
2990
  description: Data model for the complex type ExtensionList.
2557
- properties: *ref_59
2558
- required: *ref_60
2991
+ properties: *ref_52
2992
+ required: *ref_53
2559
2993
  type: object
2560
2994
  fspId:
2561
2995
  description: FSP identifier.
@@ -2564,7 +2998,7 @@ components:
2564
2998
  type: string
2565
2999
  fulfilNotification:
2566
3000
  description: PUT /transfers/{transferId} object.
2567
- properties: *ref_61
3001
+ properties: *ref_54
2568
3002
  title: TransfersIDPatchResponse
2569
3003
  type: object
2570
3004
  generalError:
@@ -2576,38 +3010,31 @@ components:
2576
3010
  description: >-
2577
3011
  Indicates the geographic location from where the transaction was
2578
3012
  initiated.
2579
- properties: *ref_19
2580
- required: *ref_20
3013
+ properties: *ref_24
3014
+ required: *ref_25
2581
3015
  type: object
2582
3016
  idSubValue:
2583
3017
  maxLength: 128
2584
3018
  minLength: 1
2585
3019
  type: string
2586
3020
  idType:
2587
- enum: *ref_21
3021
+ enum: *ref_55
2588
3022
  type: string
2589
3023
  idValue:
2590
3024
  description: Identifier of the party.
2591
3025
  maxLength: 128
2592
3026
  minLength: 1
2593
3027
  type: string
2594
- ilpFulfilment:
2595
- description: Fulfilment that must be attached to the transfer by the Payee.
2596
- example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
2597
- maxLength: 48
2598
- pattern: ^[A-Za-z0-9-_]{43}$
2599
- title: ilpFulfilment
2600
- type: string
2601
3028
  ilpPacketData:
2602
3029
  description: Object containing transfer object.
2603
- properties: *ref_62
2604
- required: *ref_63
3030
+ properties: *ref_56
3031
+ required: *ref_57
2605
3032
  type: object
2606
3033
  initiator:
2607
- enum: *ref_9
3034
+ enum: *ref_14
2608
3035
  type: string
2609
3036
  initiatorType:
2610
- enum: *ref_10
3037
+ enum: *ref_15
2611
3038
  type: string
2612
3039
  latitude:
2613
3040
  description: >-
@@ -2623,21 +3050,18 @@ components:
2623
3050
  pattern: >-
2624
3051
  ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
2625
3052
  type: string
2626
- mojaloopError:
2627
- properties: *ref_64
2628
- type: object
2629
3053
  money:
2630
3054
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2631
3055
  type: string
2632
3056
  otpDetails:
2633
- properties: *ref_65
2634
- required: *ref_66
3057
+ properties: *ref_58
3058
+ required: *ref_59
2635
3059
  type: object
2636
3060
  participantsResponse:
2637
- properties: *ref_17
3061
+ properties: *ref_22
2638
3062
  type: object
2639
3063
  payerType:
2640
- enum: *ref_22
3064
+ enum: *ref_60
2641
3065
  type: string
2642
3066
  quoteId:
2643
3067
  description: A Mojaloop API quote identifier (UUID).
@@ -2646,16 +3070,16 @@ components:
2646
3070
  type: string
2647
3071
  quoteRequest:
2648
3072
  description: A request for a quote for transfer from the DFSP backend.
2649
- properties: *ref_67
2650
- required: *ref_68
3073
+ properties: *ref_61
3074
+ required: *ref_62
2651
3075
  type: object
2652
3076
  quoteResponse:
2653
3077
  description: A response to a request for a quote.
2654
- properties: *ref_25
2655
- required: *ref_26
3078
+ properties: *ref_28
3079
+ required: *ref_29
2656
3080
  type: object
2657
3081
  scenario:
2658
- enum: *ref_69
3082
+ enum: *ref_63
2659
3083
  type: string
2660
3084
  timestamp:
2661
3085
  description: An ISO-8601 formatted timestamp.
@@ -2671,8 +3095,8 @@ components:
2671
3095
  type: string
2672
3096
  transactionRequest:
2673
3097
  description: A request for a pull based transfer.
2674
- properties: *ref_70
2675
- required: *ref_71
3098
+ properties: *ref_64
3099
+ required: *ref_65
2676
3100
  type: object
2677
3101
  transactionRequestId:
2678
3102
  description: A Mojaloop API transaction request identifier (UUID).
@@ -2681,11 +3105,11 @@ components:
2681
3105
  type: string
2682
3106
  transactionRequestResponse:
2683
3107
  description: A response to a request for a quote.
2684
- properties: *ref_72
2685
- required: *ref_73
3108
+ properties: *ref_66
3109
+ required: *ref_67
2686
3110
  type: object
2687
3111
  transactionRequestState:
2688
- enum: *ref_74
3112
+ enum: *ref_68
2689
3113
  type: string
2690
3114
  transactionSubScenario:
2691
3115
  description: >-
@@ -2696,22 +3120,16 @@ components:
2696
3120
  title: transactionSubScenario
2697
3121
  type: string
2698
3122
  transactionType:
2699
- enum: *ref_11
3123
+ enum: *ref_16
2700
3124
  type: string
2701
3125
  transactionTypeObject:
2702
3126
  description: Object containing transfer object.
2703
- properties: *ref_75
2704
- required: *ref_76
3127
+ properties: *ref_69
3128
+ required: *ref_70
2705
3129
  type: object
2706
3130
  transferDetailsResponse:
2707
- properties: *ref_77
2708
- required: *ref_78
2709
- type: object
2710
- transferError:
2711
- description: >-
2712
- This object represents a Mojaloop API error received at any time during
2713
- the transfer process.
2714
- properties: *ref_79
3131
+ properties: *ref_71
3132
+ required: *ref_72
2715
3133
  type: object
2716
3134
  transferId:
2717
3135
  description: A Mojaloop API transfer identifier (UUID).
@@ -2723,12 +3141,12 @@ components:
2723
3141
  required: *ref_2
2724
3142
  type: object
2725
3143
  transferRequest:
2726
- properties: *ref_80
2727
- required: *ref_81
3144
+ properties: *ref_73
3145
+ required: *ref_74
2728
3146
  type: object
2729
3147
  transferResponse:
2730
- properties: *ref_82
2731
- required: *ref_83
3148
+ properties: *ref_75
3149
+ required: *ref_76
2732
3150
  type: object
2733
3151
  transferState:
2734
3152
  description: >
@@ -2737,8 +3155,344 @@ components:
2737
3155
  COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP
2738
3156
  has aborted the transfer due a rejection or failure to perform the
2739
3157
  transfer.
2740
- enum: *ref_27
3158
+ enum: *ref_30
2741
3159
  type: string
2742
3160
  transferStatus:
2743
- enum: *ref_84
3161
+ enum: *ref_77
2744
3162
  type: string
3163
+ CorrelationId:
3164
+ title: CorrelationId
3165
+ type: string
3166
+ pattern: >-
3167
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
3168
+ description: >-
3169
+ Identifier that correlates all messages of the same sequence. The API
3170
+ data type UUID (Universally Unique Identifier) is a JSON String in
3171
+ canonical format, conforming to [RFC
3172
+ 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
3173
+ regular expression for interoperability reasons. A UUID is always 36
3174
+ characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
3175
+ example: b51ec534-ee48-4575-b6a9-ead2955b8069
3176
+ bulkTransactionStatus:
3177
+ type: string
3178
+ enum: *ref_78
3179
+ autoAcceptPartyOption:
3180
+ type: object
3181
+ required: *ref_79
3182
+ properties: *ref_80
3183
+ Currency:
3184
+ title: Currency
3185
+ description: >-
3186
+ The currency codes defined in [ISO
3187
+ 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
3188
+ alphabetic codes are used as the standard naming representation for
3189
+ currencies.
3190
+ type: string
3191
+ minLength: 3
3192
+ maxLength: 3
3193
+ enum: *ref_8
3194
+ Amount:
3195
+ title: Amount
3196
+ type: string
3197
+ pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
3198
+ description: >-
3199
+ The API data type Amount is a JSON String in a canonical format that is
3200
+ restricted by a regular expression for interoperability reasons. This
3201
+ pattern does not allow any trailing zeroes at all, but allows an amount
3202
+ without a minor currency unit. It also only allows four digits in the
3203
+ minor currency unit; a negative value is not allowed. Using more than 18
3204
+ digits in the major currency unit is not allowed.
3205
+ example: '123.45'
3206
+ bulkPerTransferFeeLimit:
3207
+ type: object
3208
+ required: *ref_81
3209
+ properties: *ref_82
3210
+ autoAcceptQuote:
3211
+ type: object
3212
+ required: *ref_83
3213
+ properties: *ref_84
3214
+ DateTime:
3215
+ title: DateTime
3216
+ type: string
3217
+ pattern: >-
3218
+ ^(?:[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)$
3219
+ description: >-
3220
+ The API data type DateTime is a JSON String in a lexical format that is
3221
+ restricted by a regular expression for interoperability reasons. The
3222
+ format is according to [ISO
3223
+ 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed
3224
+ in a combined date, time and time zone format. A more readable version
3225
+ of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
3226
+ "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
3227
+ indicates Zulu time zone, same as UTC).
3228
+ example: '2016-05-24T08:38:08.699-04:00'
3229
+ bulkTransactionOptions:
3230
+ type: object
3231
+ required: *ref_85
3232
+ properties: *ref_86
3233
+ PartyIdType:
3234
+ title: PartyIdType
3235
+ type: string
3236
+ enum: *ref_87
3237
+ description: >-
3238
+ Below are the allowed values for the enumeration.
3239
+
3240
+ - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
3241
+ Number, that is, the phone number) is used as reference to a
3242
+ participant. The MSISDN identifier should be in international format
3243
+ according to the [ITU-T E.164
3244
+ standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
3245
+ MSISDN may be prefixed by a single plus sign, indicating the
3246
+ international prefix.
3247
+
3248
+ - EMAIL - An email is used as reference to a participant. The format of
3249
+ the email should be according to the informational [RFC
3250
+ 3696](https://tools.ietf.org/html/rfc3696).
3251
+
3252
+ - PERSONAL_ID - A personal identifier is used as reference to a
3253
+ participant. Examples of personal identification are passport number,
3254
+ birth certificate number, and national registration number. The
3255
+ identifier number is added in the PartyIdentifier element. The personal
3256
+ identifier type is added in the PartySubIdOrType element.
3257
+
3258
+ - BUSINESS - A specific Business (for example, an organization or a
3259
+ company) is used as reference to a participant. The BUSINESS identifier
3260
+ can be in any format. To make a transaction connected to a specific
3261
+ username or bill number in a Business, the PartySubIdOrType element
3262
+ should be used.
3263
+
3264
+ - DEVICE - A specific device (for example, a POS or ATM) ID connected to
3265
+ a specific business or organization is used as reference to a Party. For
3266
+ referencing a specific device under a specific business or organization,
3267
+ use the PartySubIdOrType element.
3268
+
3269
+ - ACCOUNT_ID - A bank account number or FSP account ID should be used as
3270
+ reference to a participant. The ACCOUNT_ID identifier can be in any
3271
+ format, as formats can greatly differ depending on country and FSP.
3272
+
3273
+ - IBAN - A bank account number or FSP account ID is used as reference to
3274
+ a participant. The IBAN identifier can consist of up to 34 alphanumeric
3275
+ characters and should be entered without whitespace.
3276
+
3277
+ - ALIAS An alias is used as reference to a participant. The alias should
3278
+ be created in the FSP as an alternative reference to an account owner.
3279
+ Another example of an alias is a username in the FSP system. The ALIAS
3280
+ identifier can be in any format. It is also possible to use the
3281
+ PartySubIdOrType element for identifying an account under an Alias
3282
+ defined by the PartyIdentifier.
3283
+ PartyIdentifier:
3284
+ title: PartyIdentifier
3285
+ type: string
3286
+ minLength: 1
3287
+ maxLength: 128
3288
+ description: Identifier of the Party.
3289
+ example: '16135551212'
3290
+ PartySubIdOrType:
3291
+ title: PartySubIdOrType
3292
+ type: string
3293
+ minLength: 1
3294
+ maxLength: 128
3295
+ description: >-
3296
+ Either a sub-identifier of a PartyIdentifier, or a sub-type of the
3297
+ PartyIdType, normally a PersonalIdentifierType.
3298
+ ExtensionKey:
3299
+ title: ExtensionKey
3300
+ type: string
3301
+ minLength: 1
3302
+ maxLength: 32
3303
+ description: Extension key.
3304
+ ExtensionValue:
3305
+ title: ExtensionValue
3306
+ type: string
3307
+ minLength: 1
3308
+ maxLength: 128
3309
+ description: Extension value.
3310
+ Extension:
3311
+ title: Extension
3312
+ type: object
3313
+ description: Data model for the complex type Extension.
3314
+ properties: *ref_88
3315
+ required: *ref_89
3316
+ ExtensionList:
3317
+ title: ExtensionList
3318
+ type: object
3319
+ description: >-
3320
+ Data model for the complex type ExtensionList. An optional list of
3321
+ extensions, specific to deployment.
3322
+ properties: *ref_11
3323
+ required: *ref_12
3324
+ PartyIdInfo:
3325
+ title: PartyIdInfo
3326
+ type: object
3327
+ description: >-
3328
+ Data model for the complex type PartyIdInfo. An ExtensionList element
3329
+ has been added to this reqeust in version v1.1
3330
+ properties: *ref_90
3331
+ required: *ref_91
3332
+ PartyName:
3333
+ title: PartyName
3334
+ type: string
3335
+ minLength: 1
3336
+ maxLength: 128
3337
+ description: Name of the Party. Could be a real name or a nickname.
3338
+ PartyComplexName:
3339
+ title: PartyComplexName
3340
+ type: object
3341
+ description: Data model for the complex type PartyComplexName.
3342
+ properties: *ref_92
3343
+ PartyPersonalInfo:
3344
+ title: PartyPersonalInfo
3345
+ type: object
3346
+ description: Data model for the complex type PartyPersonalInfo.
3347
+ properties: *ref_93
3348
+ Party:
3349
+ title: Party
3350
+ type: object
3351
+ description: Data model for the complex type Party.
3352
+ properties: *ref_26
3353
+ required: *ref_27
3354
+ AmountType:
3355
+ title: AmountType
3356
+ type: string
3357
+ enum: *ref_94
3358
+ description: >-
3359
+ Below are the allowed values for the enumeration AmountType.
3360
+
3361
+ - SEND - Amount the Payer would like to send, that is, the amount that
3362
+ should be withdrawn from the Payer account including any fees.
3363
+
3364
+ - RECEIVE - Amount the Payer would like the Payee to receive, that is,
3365
+ the amount that should be sent to the receiver exclusive of any fees.
3366
+ example: RECEIVE
3367
+ Note:
3368
+ title: Note
3369
+ type: string
3370
+ minLength: 1
3371
+ maxLength: 128
3372
+ description: Memo assigned to transaction.
3373
+ example: Note sent to Payee.
3374
+ Money:
3375
+ title: Money
3376
+ type: object
3377
+ description: Data model for the complex type Money.
3378
+ properties: *ref_9
3379
+ required: *ref_10
3380
+ Latitude:
3381
+ title: Latitude
3382
+ type: string
3383
+ pattern: >-
3384
+ ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
3385
+ description: >-
3386
+ The API data type Latitude is a JSON String in a lexical format that is
3387
+ restricted by a regular expression for interoperability reasons.
3388
+ example: '+45.4215'
3389
+ Longitude:
3390
+ title: Longitude
3391
+ type: string
3392
+ pattern: >-
3393
+ ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
3394
+ description: >-
3395
+ The API data type Longitude is a JSON String in a lexical format that is
3396
+ restricted by a regular expression for interoperability reasons.
3397
+ example: '+75.6972'
3398
+ GeoCode:
3399
+ title: GeoCode
3400
+ type: object
3401
+ description: >-
3402
+ Data model for the complex type GeoCode. Indicates the geographic
3403
+ location from where the transaction was initiated.
3404
+ properties: *ref_95
3405
+ required: *ref_96
3406
+ IlpPacket:
3407
+ title: IlpPacket
3408
+ type: string
3409
+ pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
3410
+ minLength: 1
3411
+ maxLength: 32768
3412
+ description: Information for recipient (transport layer information).
3413
+ example: >-
3414
+ AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3415
+ IlpCondition:
3416
+ title: IlpCondition
3417
+ type: string
3418
+ pattern: ^[A-Za-z0-9-_]{43}$
3419
+ maxLength: 48
3420
+ description: Condition that must be attached to the transfer by the Payer.
3421
+ QuotesIDPutResponse:
3422
+ title: QuotesIDPutResponse
3423
+ type: object
3424
+ description: The object sent in the PUT /quotes/{ID} callback.
3425
+ properties: *ref_97
3426
+ required: *ref_98
3427
+ IlpFulfilment:
3428
+ title: IlpFulfilment
3429
+ type: string
3430
+ pattern: ^[A-Za-z0-9-_]{43}$
3431
+ maxLength: 48
3432
+ description: Fulfilment that must be attached to the transfer by the Payee.
3433
+ example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
3434
+ TransferState:
3435
+ title: TransferState
3436
+ type: string
3437
+ enum: *ref_99
3438
+ description: >-
3439
+ Below are the allowed values for the enumeration.
3440
+
3441
+ - RECEIVED - Next ledger has received the transfer.
3442
+
3443
+ - RESERVED - Next ledger has reserved the transfer.
3444
+
3445
+ - COMMITTED - Next ledger has successfully performed the transfer.
3446
+
3447
+ - ABORTED - Next ledger has aborted the transfer due to a rejection or
3448
+ failure to perform the transfer.
3449
+ example: RESERVED
3450
+ TransfersIDPutResponse:
3451
+ title: TransfersIDPutResponse
3452
+ type: object
3453
+ description: The object sent in the PUT /transfers/{ID} callback.
3454
+ properties: *ref_100
3455
+ required: *ref_101
3456
+ ErrorCode:
3457
+ title: ErrorCode
3458
+ type: string
3459
+ pattern: ^[1-9]\d{3}$
3460
+ description: >-
3461
+ The API data type ErrorCode is a JSON String of four characters,
3462
+ consisting of digits only. Negative numbers are not allowed. A leading
3463
+ zero is not allowed. Each error code in the API is a four-digit number,
3464
+ for example, 1234, where the first number (1 in the example) represents
3465
+ the high-level error category, the second number (2 in the example)
3466
+ represents the low-level error category, and the last two numbers (34 in
3467
+ the example) represent the specific error.
3468
+ example: '5100'
3469
+ ErrorDescription:
3470
+ title: ErrorDescription
3471
+ type: string
3472
+ minLength: 1
3473
+ maxLength: 128
3474
+ description: Error description string.
3475
+ ErrorInformation:
3476
+ title: ErrorInformation
3477
+ type: object
3478
+ description: Data model for the complex type ErrorInformation.
3479
+ properties: *ref_102
3480
+ required: *ref_103
3481
+ mojaloopError:
3482
+ type: object
3483
+ properties: *ref_104
3484
+ transferError:
3485
+ type: object
3486
+ description: >-
3487
+ This object represents a Mojaloop API error received at any time during
3488
+ the transfer process
3489
+ properties: *ref_32
3490
+ bulkTransactionIndividualTransferResult:
3491
+ type: object
3492
+ required: *ref_105
3493
+ properties: *ref_106
3494
+ bulkTransactionResponse:
3495
+ title: BulkTransactionResponse
3496
+ type: object
3497
+ required: *ref_107
3498
+ properties: *ref_108