@mojaloop/api-snippets 14.2.1 → 14.2.3

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 (21) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/CODEOWNERS +1 -1
  3. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +698 -490
  4. package/lib/sdk-scheme-adapter/outbound/v2_0_0/json-schemas.json +4409 -6364
  5. package/lib/sdk-scheme-adapter/outbound/v2_0_0/openapi.d.ts +13116 -15712
  6. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.d.ts +1088 -1938
  7. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.js +7 -1
  8. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.js.map +1 -1
  9. package/lib/sdk-scheme-adapter/outbound/v2_0_0/types.d.ts +7 -1
  10. package/package.json +8 -8
  11. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/TransactionType.yaml +20 -4
  12. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkQuoteResponse.yaml +6 -4
  13. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferResponse.yaml +15 -4
  14. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuote.yaml +1 -1
  15. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuoteResult.yaml +23 -12
  16. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransfer.yaml +1 -1
  17. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransferResult.yaml +8 -29
  18. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/requestToPayTransferResponse.yaml +1 -1
  19. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/transferRequest.yaml +1 -1
  20. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/transferResponse.yaml +1 -1
  21. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/transferTransactionType.yaml +5 -0
package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml CHANGED
@@ -79,7 +79,7 @@ paths:
79
79
  application/json:
80
80
  schema:
81
81
  type: object
82
- required: &ref_66
82
+ required: &ref_69
83
83
  - homeTransactionId
84
84
  - from
85
85
  - to
@@ -87,7 +87,7 @@ paths:
87
87
  - currency
88
88
  - amount
89
89
  - transactionType
90
- properties: &ref_67
90
+ properties: &ref_70
91
91
  homeTransactionId:
92
92
  type: string
93
93
  description: >-
@@ -102,7 +102,7 @@ paths:
102
102
  type:
103
103
  title: TransactionInitiatorType
104
104
  type: string
105
- enum: &ref_50
105
+ enum: &ref_51
106
106
  - CONSUMER
107
107
  - AGENT
108
108
  - BUSINESS
@@ -511,6 +511,7 @@ paths:
511
511
  than 18 digits in the major currency unit is not allowed.
512
512
  example: '123.45'
513
513
  transactionType:
514
+ title: transferTransactionType
514
515
  type: string
515
516
  enum: &ref_5
516
517
  - TRANSFER
@@ -625,6 +626,7 @@ paths:
625
626
  not allowed.
626
627
  example: '123.45'
627
628
  transactionType:
629
+ title: transferTransactionType
628
630
  type: string
629
631
  enum: *ref_5
630
632
  description: Type of transaction.
@@ -675,7 +677,7 @@ paths:
675
677
  title: QuotesIDPutResponse
676
678
  type: object
677
679
  description: The object sent in the PUT /quotes/{ID} callback.
678
- properties: &ref_27
680
+ properties: &ref_55
679
681
  transferAmount:
680
682
  title: Money
681
683
  type: object
@@ -756,7 +758,7 @@ paths:
756
758
  Data model for the complex type GeoCode. Indicates
757
759
  the geographic location from where the transaction
758
760
  was initiated.
759
- properties: &ref_63
761
+ properties: &ref_43
760
762
  latitude:
761
763
  title: Latitude
762
764
  type: string
@@ -779,7 +781,7 @@ paths:
779
781
  regular expression for interoperability
780
782
  reasons.
781
783
  example: '+75.6972'
782
- required: &ref_64
784
+ required: &ref_44
783
785
  - latitude
784
786
  - longitude
785
787
  ilpPacket:
@@ -822,7 +824,7 @@ paths:
822
824
  description: Number of Extension elements.
823
825
  required: &ref_11
824
826
  - extension
825
- required: &ref_28
827
+ required: &ref_56
826
828
  - transferAmount
827
829
  - expiration
828
830
  - ilpPacket
@@ -876,7 +878,7 @@ paths:
876
878
  transferState:
877
879
  title: TransferState
878
880
  type: string
879
- enum: &ref_68
881
+ enum: &ref_27
880
882
  - RECEIVED
881
883
  - RESERVED
882
884
  - COMMITTED
@@ -929,12 +931,12 @@ paths:
929
931
  property will contain the underlying Mojaloop API
930
932
  error object.
931
933
  type: object
932
- properties: &ref_37
934
+ properties: &ref_36
933
935
  errorInformation:
934
936
  title: ErrorInformation
935
937
  type: object
936
938
  description: Data model for the complex type ErrorInformation.
937
- properties: &ref_57
939
+ properties: &ref_62
938
940
  errorCode:
939
941
  title: ErrorCode
940
942
  type: string
@@ -967,7 +969,7 @@ paths:
967
969
  deployment.
968
970
  properties: *ref_10
969
971
  required: *ref_11
970
- required: &ref_58
972
+ required: &ref_63
971
973
  - errorCode
972
974
  - errorDescription
973
975
  skipPartyLookup:
@@ -978,7 +980,7 @@ paths:
978
980
  type: boolean
979
981
  '400':
980
982
  description: Malformed or missing required body, headers or parameters
981
- content: &ref_137
983
+ content: &ref_143
982
984
  application/json:
983
985
  schema:
984
986
  allOf: &ref_14
@@ -1036,17 +1038,17 @@ paths:
1036
1038
  schema:
1037
1039
  oneOf:
1038
1040
  - type: object
1039
- required: &ref_29
1041
+ required: &ref_28
1040
1042
  - acceptParty
1041
- properties: &ref_30
1043
+ properties: &ref_29
1042
1044
  acceptParty:
1043
1045
  type: boolean
1044
1046
  enum:
1045
1047
  - true
1046
1048
  - type: object
1047
- required: &ref_33
1049
+ required: &ref_32
1048
1050
  - acceptQuote
1049
- properties: &ref_34
1051
+ properties: &ref_33
1050
1052
  acceptQuote:
1051
1053
  type: boolean
1052
1054
  enum:
@@ -1107,11 +1109,11 @@ paths:
1107
1109
  application/json:
1108
1110
  schema:
1109
1111
  type: object
1110
- required: &ref_69
1112
+ required: &ref_71
1111
1113
  - transferId
1112
1114
  - currentState
1113
1115
  - fulfil
1114
- properties: &ref_70
1116
+ properties: &ref_72
1115
1117
  transferId:
1116
1118
  title: CorrelationId
1117
1119
  type: string
@@ -1164,12 +1166,12 @@ paths:
1164
1166
  application/json:
1165
1167
  schema:
1166
1168
  type: object
1167
- required: &ref_85
1169
+ required: &ref_87
1168
1170
  - bulkHomeTransactionID
1169
1171
  - options
1170
1172
  - from
1171
1173
  - individualTransfers
1172
- properties: &ref_86
1174
+ properties: &ref_88
1173
1175
  bulkHomeTransactionID:
1174
1176
  type: string
1175
1177
  description: >-
@@ -1191,11 +1193,11 @@ paths:
1191
1193
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1192
1194
  options:
1193
1195
  type: object
1194
- required: &ref_77
1196
+ required: &ref_79
1195
1197
  - autoAcceptParty
1196
1198
  - autoAcceptQuote
1197
1199
  - bulkExpiration
1198
- properties: &ref_78
1200
+ properties: &ref_80
1199
1201
  onlyValidateParty:
1200
1202
  description: >-
1201
1203
  Set to true if only party validation is required. This
@@ -1204,9 +1206,9 @@ paths:
1204
1206
  type: boolean
1205
1207
  autoAcceptParty:
1206
1208
  type: object
1207
- required: &ref_71
1209
+ required: &ref_73
1208
1210
  - enabled
1209
- properties: &ref_72
1211
+ properties: &ref_74
1210
1212
  enabled:
1211
1213
  type: boolean
1212
1214
  enum:
@@ -1221,9 +1223,9 @@ paths:
1221
1223
  type: object
1222
1224
  oneOf:
1223
1225
  - type: object
1224
- required: &ref_75
1226
+ required: &ref_77
1225
1227
  - enabled
1226
- properties: &ref_76
1228
+ properties: &ref_78
1227
1229
  enabled:
1228
1230
  type: boolean
1229
1231
  enum:
@@ -1234,10 +1236,10 @@ paths:
1234
1236
  minItems: 0
1235
1237
  items:
1236
1238
  type: object
1237
- required: &ref_73
1239
+ required: &ref_75
1238
1240
  - currency
1239
1241
  - amount
1240
- properties: &ref_74
1242
+ properties: &ref_76
1241
1243
  currency:
1242
1244
  title: Currency
1243
1245
  description: >-
@@ -1311,7 +1313,7 @@ paths:
1311
1313
  Data model for the complex type PartyIdInfo. An
1312
1314
  ExtensionList element has been added to this reqeust in
1313
1315
  version v1.1
1314
- properties: &ref_79
1316
+ properties: &ref_81
1315
1317
  partyIdType:
1316
1318
  title: PartyIdType
1317
1319
  type: string
@@ -1404,7 +1406,7 @@ paths:
1404
1406
  optional list of extensions, specific to deployment.
1405
1407
  properties: *ref_10
1406
1408
  required: *ref_11
1407
- required: &ref_80
1409
+ required: &ref_82
1408
1410
  - partyIdType
1409
1411
  - partyIdentifier
1410
1412
  merchantClassificationCode:
@@ -1426,12 +1428,12 @@ paths:
1426
1428
  title: PartyPersonalInfo
1427
1429
  type: object
1428
1430
  description: Data model for the complex type PartyPersonalInfo.
1429
- properties: &ref_82
1431
+ properties: &ref_84
1430
1432
  complexName:
1431
1433
  title: PartyComplexName
1432
1434
  type: object
1433
1435
  description: Data model for the complex type PartyComplexName.
1434
- properties: &ref_81
1436
+ properties: &ref_83
1435
1437
  firstName:
1436
1438
  title: FirstName
1437
1439
  type: string
@@ -1480,7 +1482,7 @@ paths:
1480
1482
  title: IndividualTransaction
1481
1483
  type: object
1482
1484
  description: Data model for the complex type 'individualTransaction'.
1483
- properties: &ref_83
1485
+ properties: &ref_85
1484
1486
  homeTransactionId:
1485
1487
  title: CorrelationId
1486
1488
  type: string
@@ -1576,7 +1578,7 @@ paths:
1576
1578
  This object represents a Mojaloop API error received
1577
1579
  at any time during the transfer process
1578
1580
  properties: *ref_26
1579
- required: &ref_84
1581
+ required: &ref_86
1580
1582
  - homeTransactionId
1581
1583
  - to
1582
1584
  - amountType
@@ -1596,10 +1598,10 @@ paths:
1596
1598
  description: Bulk transfer accepted successfully
1597
1599
  '400':
1598
1600
  description: Malformed or missing required body, headers or parameters
1599
- content: &ref_42
1601
+ content: &ref_41
1600
1602
  application/json:
1601
1603
  schema:
1602
- allOf: &ref_89
1604
+ allOf: &ref_91
1603
1605
  - type: object
1604
1606
  properties: *ref_22
1605
1607
  - type: object
@@ -1608,11 +1610,11 @@ paths:
1608
1610
  properties:
1609
1611
  bulkTransferState:
1610
1612
  type: object
1611
- required: &ref_40
1612
- - from
1613
+ required: &ref_39
1614
+ - bulkTransferId
1613
1615
  - individualTransferResults
1614
- properties: &ref_41
1615
- transferId:
1616
+ properties: &ref_40
1617
+ bulkTransferId:
1616
1618
  title: CorrelationId
1617
1619
  type: string
1618
1620
  pattern: >-
@@ -1628,22 +1630,83 @@ paths:
1628
1630
  characters long, 32 hexadecimal symbols and 4
1629
1631
  dashes (‘-‘).
1630
1632
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1631
- from:
1633
+ bulkQuoteId:
1634
+ title: CorrelationId
1635
+ type: string
1636
+ pattern: >-
1637
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1638
+ description: >-
1639
+ Identifier that correlates all messages of the
1640
+ same sequence. The API data type UUID (Universally
1641
+ Unique Identifier) is a JSON String in canonical
1642
+ format, conforming to [RFC
1643
+ 4122](https://tools.ietf.org/html/rfc4122), that
1644
+ is restricted by a regular expression for
1645
+ interoperability reasons. A UUID is always 36
1646
+ characters long, 32 hexadecimal symbols and 4
1647
+ dashes (‘-‘).
1648
+ example: b51ec534-ee48-4575-b6a9-ead2955b8069
1649
+ homeTransactionId:
1650
+ type: string
1651
+ description: >-
1652
+ Transaction ID from the DFSP backend, used to
1653
+ reconcile transactions between the Switch and DFSP
1654
+ backend systems.
1655
+ bulkTransferState:
1656
+ title: TransferState
1657
+ type: string
1658
+ enum: *ref_27
1659
+ description: >-
1660
+ Below are the allowed values for the enumeration.
1661
+
1662
+ - RECEIVED - Next ledger has received the
1663
+ transfer.
1664
+
1665
+ - RESERVED - Next ledger has reserved the
1666
+ transfer.
1667
+
1668
+ - COMMITTED - Next ledger has successfully
1669
+ performed the transfer.
1670
+
1671
+ - ABORTED - Next ledger has aborted the transfer
1672
+ due to a rejection or failure to perform the
1673
+ transfer.
1674
+ example: RESERVED
1675
+ completedTimestamp:
1676
+ title: DateTime
1677
+ type: string
1678
+ pattern: >-
1679
+ ^(?:[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)$
1680
+ description: >-
1681
+ The API data type DateTime is a JSON String in a
1682
+ lexical format that is restricted by a regular
1683
+ expression for interoperability reasons. The
1684
+ format is according to [ISO
1685
+ 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
1686
+ expressed in a combined date, time and time zone
1687
+ format. A more readable version of the format is
1688
+ yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
1689
+ "2016-05-24T08:38:08.699-04:00",
1690
+ "2016-05-24T08:38:08.699Z" (where Z indicates Zulu
1691
+ time zone, same as UTC).
1692
+ example: '2016-05-24T08:38:08.699-04:00'
1693
+ extensionList:
1694
+ title: ExtensionList
1632
1695
  type: object
1633
- required: *ref_0
1634
- properties: *ref_1
1696
+ description: >-
1697
+ Data model for the complex type ExtensionList. An
1698
+ optional list of extensions, specific to
1699
+ deployment.
1700
+ properties: *ref_10
1701
+ required: *ref_11
1635
1702
  individualTransferResults:
1636
1703
  type: array
1637
1704
  maxItems: 1000
1638
1705
  items:
1639
1706
  type: object
1640
- required: &ref_87
1641
- - transactionId
1642
- - to
1643
- - amountType
1644
- - currency
1645
- - amount
1646
- properties: &ref_88
1707
+ required: &ref_89
1708
+ - transferId
1709
+ properties: &ref_90
1647
1710
  transferId:
1648
1711
  title: CorrelationId
1649
1712
  type: string
@@ -1661,109 +1724,24 @@ paths:
1661
1724
  always 36 characters long, 32 hexadecimal
1662
1725
  symbols and 4 dashes (‘-‘).
1663
1726
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1664
- to:
1665
- type: object
1666
- required: *ref_0
1667
- properties: *ref_1
1668
- amountType:
1669
- title: AmountType
1670
- type: string
1671
- enum: *ref_3
1672
- description: >-
1673
- Below are the allowed values for the
1674
- enumeration AmountType.
1675
-
1676
- - SEND - Amount the Payer would like to
1677
- send, that is, the amount that should be
1678
- withdrawn from the Payer account including
1679
- any fees.
1680
-
1681
- - RECEIVE - Amount the Payer would like the
1682
- Payee to receive, that is, the amount that
1683
- should be sent to the receiver exclusive of
1684
- any fees.
1685
- example: RECEIVE
1686
- currency:
1687
- title: Currency
1688
- description: >-
1689
- The currency codes defined in [ISO
1690
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
1691
- as three-letter alphabetic codes are used as
1692
- the standard naming representation for
1693
- currencies.
1694
- type: string
1695
- minLength: 3
1696
- maxLength: 3
1697
- enum: *ref_4
1698
- amount:
1699
- title: Amount
1700
- type: string
1701
- pattern: >-
1702
- ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1727
+ fulfilment:
1703
1728
  description: >-
1704
- The API data type Amount is a JSON String in
1705
- a canonical format that is restricted by a
1706
- regular expression for interoperability
1707
- reasons. This pattern does not allow any
1708
- trailing zeroes at all, but allows an amount
1709
- without a minor currency unit. It also only
1710
- allows four digits in the minor currency
1711
- unit; a negative value is not allowed. Using
1712
- more than 18 digits in the major currency
1713
- unit is not allowed.
1714
- example: '123.45'
1715
- transactionType:
1729
+ Fulfilment that must be attached to the
1730
+ transfer by the Payee.
1731
+ title: IlpFulfilment
1716
1732
  type: string
1717
- enum: *ref_5
1718
- description: Type of transaction.
1719
- note:
1720
- title: Note
1721
- type: string
1722
- minLength: 1
1723
- maxLength: 128
1724
- description: Memo assigned to transaction.
1725
- example: Note sent to Payee.
1726
- quoteId:
1727
- title: CorrelationId
1728
- type: string
1729
- pattern: >-
1730
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1731
- description: >-
1732
- Identifier that correlates all messages of
1733
- the same sequence. The API data type UUID
1734
- (Universally Unique Identifier) is a JSON
1735
- String in canonical format, conforming to
1736
- [RFC
1737
- 4122](https://tools.ietf.org/html/rfc4122),
1738
- that is restricted by a regular expression
1739
- for interoperability reasons. A UUID is
1740
- always 36 characters long, 32 hexadecimal
1741
- symbols and 4 dashes (‘-‘).
1742
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1743
- quoteResponse:
1744
- title: QuotesIDPutResponse
1745
- type: object
1733
+ pattern: ^[A-Za-z0-9-_]{43}$
1734
+ maxLength: 48
1735
+ example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
1736
+ extensionList:
1746
1737
  description: >-
1747
- The object sent in the PUT /quotes/{ID}
1748
- callback.
1749
- properties: *ref_27
1750
- required: *ref_28
1751
- quoteResponseSource:
1752
- type: string
1753
- description: >
1754
- FSPID of the entity that supplied the quote
1755
- response. This may not be the same as the
1756
- FSPID of the entity which owns the end user
1757
- account in the case of a FOREX transfer.
1758
- i.e. it may be a FOREX gateway.
1759
- fulfil:
1760
- title: TransfersIDPutResponse
1738
+ Data model for the complex type
1739
+ ExtensionList. An optional list of
1740
+ extensions, specific to deployment.
1741
+ title: ExtensionList
1761
1742
  type: object
1762
- description: >-
1763
- The object sent in the PUT /transfers/{ID}
1764
- callback.
1765
- properties: *ref_20
1766
- required: *ref_21
1743
+ properties: *ref_10
1744
+ required: *ref_11
1767
1745
  lastError:
1768
1746
  type: object
1769
1747
  description: >-
@@ -1776,7 +1754,7 @@ paths:
1776
1754
  transfer response.
1777
1755
  '500':
1778
1756
  description: Internal Server Error
1779
- content: &ref_43
1757
+ content: &ref_42
1780
1758
  application/json:
1781
1759
  schema:
1782
1760
  type: object
@@ -1797,7 +1775,7 @@ paths:
1797
1775
  - name: bulkTransactionId
1798
1776
  in: path
1799
1777
  required: true
1800
- schema: &ref_153
1778
+ schema: &ref_159
1801
1779
  title: CorrelationId
1802
1780
  type: string
1803
1781
  pattern: >-
@@ -1824,10 +1802,10 @@ paths:
1824
1802
  The object sent back as confirmation of payee parties when
1825
1803
  autoAcceptParty is false.
1826
1804
  type: object
1827
- required: &ref_35
1805
+ required: &ref_34
1828
1806
  - bulkHomeTransactionID
1829
1807
  - individualTransfers
1830
- properties: &ref_36
1808
+ properties: &ref_35
1831
1809
  bulkHomeTransactionID:
1832
1810
  type: string
1833
1811
  description: >-
@@ -1847,7 +1825,7 @@ paths:
1847
1825
  description: >-
1848
1826
  Data model for the 'individualTransfer' while
1849
1827
  accepting party or quote.
1850
- properties: &ref_31
1828
+ properties: &ref_30
1851
1829
  homeTransactionId:
1852
1830
  title: CorrelationId
1853
1831
  type: string
@@ -1880,20 +1858,20 @@ paths:
1880
1858
  characters long, 32 hexadecimal symbols and 4
1881
1859
  dashes (‘-‘).
1882
1860
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1883
- required: &ref_32
1861
+ required: &ref_31
1884
1862
  - homeTransactionId
1885
1863
  - transactionId
1886
1864
  - type: object
1887
- required: *ref_29
1888
- properties: *ref_30
1865
+ required: *ref_28
1866
+ properties: *ref_29
1889
1867
  - description: >-
1890
1868
  The object sent back as confirmation of quotes when
1891
1869
  autoAcceptQuotes is false.
1892
1870
  type: object
1893
- required: &ref_38
1871
+ required: &ref_37
1894
1872
  - bulkHomeTransactionID
1895
1873
  - individualTransfers
1896
- properties: &ref_39
1874
+ properties: &ref_38
1897
1875
  bulkHomeTransactionID:
1898
1876
  type: string
1899
1877
  description: >-
@@ -1911,22 +1889,22 @@ paths:
1911
1889
  description: >-
1912
1890
  Data model for the 'individualTransfer' while
1913
1891
  accepting party or quote.
1914
- properties: *ref_31
1915
- required: *ref_32
1892
+ properties: *ref_30
1893
+ required: *ref_31
1916
1894
  - type: object
1917
- required: *ref_33
1918
- properties: *ref_34
1895
+ required: *ref_32
1896
+ properties: *ref_33
1919
1897
  required: true
1920
1898
  responses:
1921
1899
  '202':
1922
1900
  description: Bulk transaction information successfully amended
1923
1901
  '400':
1924
1902
  description: Malformed or missing required body, headers or parameters
1925
- content: &ref_138
1903
+ content: &ref_144
1926
1904
  application/json:
1927
1905
  schema:
1928
1906
  oneOf:
1929
- - allOf: &ref_91
1907
+ - allOf: &ref_93
1930
1908
  - type: object
1931
1909
  properties: *ref_22
1932
1910
  - type: object
@@ -1939,14 +1917,14 @@ paths:
1939
1917
  The object sent back as confirmation of payee
1940
1918
  parties when autoAcceptParty is false.
1941
1919
  type: object
1942
- required: *ref_35
1943
- properties: *ref_36
1920
+ required: *ref_34
1921
+ properties: *ref_35
1944
1922
  - type: object
1945
1923
  description: >-
1946
1924
  This object represents a Mojaloop API error
1947
1925
  received at any time during the party
1948
1926
  discovery process
1949
- properties: &ref_90
1927
+ properties: &ref_92
1950
1928
  httpStatusCode:
1951
1929
  type: integer
1952
1930
  description: >-
@@ -1961,8 +1939,8 @@ paths:
1961
1939
  API exchange, this property will contain
1962
1940
  the underlying Mojaloop API error object.
1963
1941
  type: object
1964
- properties: *ref_37
1965
- - allOf: &ref_92
1942
+ properties: *ref_36
1943
+ - allOf: &ref_94
1966
1944
  - type: object
1967
1945
  properties: *ref_22
1968
1946
  - type: object
@@ -1975,13 +1953,13 @@ paths:
1975
1953
  The object sent back as confirmation of quotes
1976
1954
  when autoAcceptQuotes is false.
1977
1955
  type: object
1978
- required: *ref_38
1979
- properties: *ref_39
1956
+ required: *ref_37
1957
+ properties: *ref_38
1980
1958
  - type: object
1981
1959
  description: >-
1982
1960
  This object represents a Mojaloop API error
1983
1961
  received at any time during the quote process
1984
- properties: &ref_44
1962
+ properties: &ref_45
1985
1963
  httpStatusCode:
1986
1964
  type: integer
1987
1965
  description: >-
@@ -1996,7 +1974,7 @@ paths:
1996
1974
  API exchange, this property will contain
1997
1975
  the underlying Mojaloop API error object.
1998
1976
  type: object
1999
- properties: *ref_37
1977
+ properties: *ref_36
2000
1978
  '500':
2001
1979
  description: An error occurred processing the bulk transaction
2002
1980
  content:
@@ -2018,11 +1996,11 @@ paths:
2018
1996
  application/json:
2019
1997
  schema:
2020
1998
  type: object
2021
- required: &ref_95
1999
+ required: &ref_97
2022
2000
  - homeTransactionId
2023
2001
  - from
2024
2002
  - individualTransfers
2025
- properties: &ref_96
2003
+ properties: &ref_98
2026
2004
  homeTransactionId:
2027
2005
  type: string
2028
2006
  description: >-
@@ -2055,7 +2033,7 @@ paths:
2055
2033
  title: IndividualTransfer
2056
2034
  type: object
2057
2035
  description: Data model for the complex type 'individualTransfer'.
2058
- properties: &ref_93
2036
+ properties: &ref_95
2059
2037
  transferId:
2060
2038
  title: CorrelationId
2061
2039
  type: string
@@ -2118,6 +2096,7 @@ paths:
2118
2096
  digits in the major currency unit is not allowed.
2119
2097
  example: '123.45'
2120
2098
  transactionType:
2099
+ title: transferTransactionType
2121
2100
  type: string
2122
2101
  enum: *ref_5
2123
2102
  description: Type of transaction.
@@ -2136,7 +2115,7 @@ paths:
2136
2115
  optional list of extensions, specific to deployment.
2137
2116
  properties: *ref_10
2138
2117
  required: *ref_11
2139
- required: &ref_94
2118
+ required: &ref_96
2140
2119
  - transferId
2141
2120
  - to
2142
2121
  - amountType
@@ -2154,18 +2133,18 @@ paths:
2154
2133
  responses:
2155
2134
  '200':
2156
2135
  description: Bulk transfer completed successfully
2157
- content: &ref_139
2136
+ content: &ref_145
2158
2137
  application/json:
2159
2138
  schema:
2160
2139
  type: object
2161
- required: *ref_40
2162
- properties: *ref_41
2140
+ required: *ref_39
2141
+ properties: *ref_40
2163
2142
  '400':
2164
2143
  description: Malformed or missing required body, headers or parameters
2165
- content: *ref_42
2144
+ content: *ref_41
2166
2145
  '500':
2167
2146
  description: Internal Server Error
2168
- content: *ref_43
2147
+ content: *ref_42
2169
2148
  /bulkTransfers/{bulkTransferId}:
2170
2149
  get:
2171
2150
  summary: Retrieves information for a specific bulk transfer
@@ -2180,7 +2159,7 @@ paths:
2180
2159
  - name: bulkTransferId
2181
2160
  in: path
2182
2161
  required: true
2183
- schema: &ref_154
2162
+ schema: &ref_160
2184
2163
  title: CorrelationId
2185
2164
  type: string
2186
2165
  pattern: >-
@@ -2204,11 +2183,11 @@ paths:
2204
2183
  application/json:
2205
2184
  schema:
2206
2185
  type: object
2207
- required: &ref_99
2186
+ required: &ref_101
2208
2187
  - bulkTransferId
2209
2188
  - currentState
2210
2189
  - fulfils
2211
- properties: &ref_100
2190
+ properties: &ref_102
2212
2191
  bulkTransferId:
2213
2192
  title: CorrelationId
2214
2193
  type: string
@@ -2226,7 +2205,7 @@ paths:
2226
2205
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
2227
2206
  currentState:
2228
2207
  type: string
2229
- enum: &ref_97
2208
+ enum: &ref_99
2230
2209
  - ERROR_OCCURRED
2231
2210
  - COMPLETED
2232
2211
  fulfils:
@@ -2238,7 +2217,7 @@ paths:
2238
2217
  description: >-
2239
2218
  A Mojaloop API transfer fulfilment for individual
2240
2219
  transfers in a bulk transfer
2241
- properties: &ref_98
2220
+ properties: &ref_100
2242
2221
  fulfilment:
2243
2222
  description: >-
2244
2223
  Fulfilment that must be attached to the transfer by
@@ -2277,11 +2256,11 @@ paths:
2277
2256
  application/json:
2278
2257
  schema:
2279
2258
  type: object
2280
- required: &ref_101
2259
+ required: &ref_103
2281
2260
  - homeTransactionId
2282
2261
  - from
2283
2262
  - individualQuotes
2284
- properties: &ref_102
2263
+ properties: &ref_104
2285
2264
  homeTransactionId:
2286
2265
  type: string
2287
2266
  description: >-
@@ -2314,7 +2293,7 @@ paths:
2314
2293
  title: IndividualQuote
2315
2294
  type: object
2316
2295
  description: Data model for the complex type 'individualQuote'.
2317
- properties: &ref_48
2296
+ properties: &ref_49
2318
2297
  quoteId:
2319
2298
  title: CorrelationId
2320
2299
  type: string
@@ -2377,6 +2356,7 @@ paths:
2377
2356
  digits in the major currency unit is not allowed.
2378
2357
  example: '123.45'
2379
2358
  transactionType:
2359
+ title: transferTransactionType
2380
2360
  type: string
2381
2361
  enum: *ref_5
2382
2362
  description: Type of transaction.
@@ -2395,7 +2375,7 @@ paths:
2395
2375
  optional list of extensions, specific to deployment.
2396
2376
  properties: *ref_10
2397
2377
  required: *ref_11
2398
- required: &ref_49
2378
+ required: &ref_50
2399
2379
  - quoteId
2400
2380
  - to
2401
2381
  - amountType
@@ -2413,15 +2393,15 @@ paths:
2413
2393
  responses:
2414
2394
  '200':
2415
2395
  description: Bulk quote completed successfully
2416
- content: &ref_140
2396
+ content: &ref_146
2417
2397
  application/json:
2418
2398
  schema:
2419
2399
  type: object
2420
- required: &ref_45
2421
- - from
2400
+ required: &ref_46
2401
+ - bulkQuoteId
2422
2402
  - individualQuoteResults
2423
- properties: &ref_46
2424
- quoteId:
2403
+ properties: &ref_47
2404
+ bulkQuoteId:
2425
2405
  title: CorrelationId
2426
2406
  type: string
2427
2407
  pattern: >-
@@ -2441,16 +2421,37 @@ paths:
2441
2421
  description: >-
2442
2422
  Transaction ID from the DFSP backend, used to reconcile
2443
2423
  transactions between the Switch and DFSP backend systems.
2444
- from:
2424
+ expiration:
2425
+ title: DateTime
2426
+ type: string
2427
+ pattern: >-
2428
+ ^(?:[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)$
2429
+ description: >-
2430
+ The API data type DateTime is a JSON String in a lexical
2431
+ format that is restricted by a regular expression for
2432
+ interoperability reasons. The format is according to [ISO
2433
+ 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
2434
+ expressed in a combined date, time and time zone format. A
2435
+ more readable version of the format is
2436
+ yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
2437
+ "2016-05-24T08:38:08.699-04:00",
2438
+ "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time
2439
+ zone, same as UTC).
2440
+ example: '2016-05-24T08:38:08.699-04:00'
2441
+ extensionList:
2442
+ title: ExtensionList
2445
2443
  type: object
2446
- required: *ref_0
2447
- properties: *ref_1
2444
+ description: >-
2445
+ Data model for the complex type ExtensionList. An optional
2446
+ list of extensions, specific to deployment.
2447
+ properties: *ref_10
2448
+ required: *ref_11
2448
2449
  individualQuoteResults:
2449
2450
  type: array
2450
2451
  maxItems: 1000
2451
2452
  items:
2452
2453
  type: object
2453
- properties: &ref_103
2454
+ properties: &ref_105
2454
2455
  quoteId:
2455
2456
  title: CorrelationId
2456
2457
  type: string
@@ -2467,78 +2468,86 @@ paths:
2467
2468
  characters long, 32 hexadecimal symbols and 4 dashes
2468
2469
  (‘-‘).
2469
2470
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
2470
- to:
2471
+ transferAmount:
2472
+ title: Money
2473
+ type: object
2474
+ description: Data model for the complex type Money.
2475
+ properties: *ref_6
2476
+ required: *ref_7
2477
+ payeeReceiveAmount:
2478
+ title: Money
2479
+ type: object
2480
+ description: Data model for the complex type Money.
2481
+ properties: *ref_6
2482
+ required: *ref_7
2483
+ payeeFspFee:
2484
+ title: Money
2485
+ type: object
2486
+ description: Data model for the complex type Money.
2487
+ properties: *ref_6
2488
+ required: *ref_7
2489
+ payeeFspCommission:
2490
+ title: Money
2491
+ type: object
2492
+ description: Data model for the complex type Money.
2493
+ properties: *ref_6
2494
+ required: *ref_7
2495
+ geoCode:
2496
+ title: GeoCode
2471
2497
  type: object
2472
- required: *ref_0
2473
- properties: *ref_1
2474
- amountType:
2475
- title: AmountType
2476
- type: string
2477
- enum: *ref_3
2478
- description: >-
2479
- Below are the allowed values for the enumeration
2480
- AmountType.
2481
-
2482
- - SEND - Amount the Payer would like to send, that
2483
- is, the amount that should be withdrawn from the
2484
- Payer account including any fees.
2485
-
2486
- - RECEIVE - Amount the Payer would like the Payee to
2487
- receive, that is, the amount that should be sent to
2488
- the receiver exclusive of any fees.
2489
- example: RECEIVE
2490
- currency:
2491
- title: Currency
2492
2498
  description: >-
2493
- The currency codes defined in [ISO
2494
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
2495
- as three-letter alphabetic codes are used as the
2496
- standard naming representation for currencies.
2497
- type: string
2498
- minLength: 3
2499
- maxLength: 3
2500
- enum: *ref_4
2501
- amount:
2502
- title: Amount
2499
+ Data model for the complex type GeoCode. Indicates
2500
+ the geographic location from where the transaction
2501
+ was initiated.
2502
+ properties: *ref_43
2503
+ required: *ref_44
2504
+ ilpPacket:
2505
+ title: IlpPacket
2503
2506
  type: string
2504
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2507
+ pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
2508
+ minLength: 1
2509
+ maxLength: 32768
2505
2510
  description: >-
2506
- The API data type Amount is a JSON String in a
2507
- canonical format that is restricted by a regular
2508
- expression for interoperability reasons. This
2509
- pattern does not allow any trailing zeroes at all,
2510
- but allows an amount without a minor currency unit.
2511
- It also only allows four digits in the minor
2512
- currency unit; a negative value is not allowed.
2513
- Using more than 18 digits in the major currency unit
2514
- is not allowed.
2515
- example: '123.45'
2516
- transactionType:
2517
- type: string
2518
- enum: *ref_5
2519
- description: Type of transaction.
2520
- note:
2521
- title: Note
2511
+ Information for recipient (transport layer
2512
+ information).
2513
+ example: >-
2514
+ AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
2515
+ condition:
2516
+ title: IlpCondition
2522
2517
  type: string
2523
- minLength: 1
2524
- maxLength: 128
2525
- description: Memo assigned to transaction.
2526
- example: Note sent to Payee.
2518
+ pattern: ^[A-Za-z0-9-_]{43}$
2519
+ maxLength: 48
2520
+ description: >-
2521
+ Condition that must be attached to the transfer by
2522
+ the Payer.
2523
+ extensionList:
2524
+ description: >-
2525
+ Data model for the complex type ExtensionList. An
2526
+ optional list of extensions, specific to deployment.
2527
+ title: ExtensionList
2528
+ type: object
2529
+ properties: *ref_10
2530
+ required: *ref_11
2527
2531
  lastError:
2528
2532
  description: >-
2529
2533
  This object represents a Mojaloop API error received
2530
2534
  at any time during the quote process
2531
2535
  type: object
2532
- properties: *ref_44
2536
+ properties: *ref_45
2537
+ required: &ref_106
2538
+ - transferAmount
2539
+ - expiration
2540
+ - ilpPacket
2541
+ - condition
2533
2542
  description: >-
2534
2543
  List of individualQuoteResults in a bulk transfer
2535
2544
  response.
2536
2545
  '400':
2537
2546
  description: Malformed or missing required body, headers or parameters
2538
- content: &ref_141
2547
+ content: &ref_147
2539
2548
  application/json:
2540
2549
  schema:
2541
- allOf: &ref_47
2550
+ allOf: &ref_48
2542
2551
  - type: object
2543
2552
  properties: *ref_22
2544
2553
  - type: object
@@ -2547,20 +2556,20 @@ paths:
2547
2556
  properties:
2548
2557
  bulkQuoteState:
2549
2558
  type: object
2550
- required: *ref_45
2551
- properties: *ref_46
2559
+ required: *ref_46
2560
+ properties: *ref_47
2552
2561
  '500':
2553
2562
  description: An error occurred processing the bulk quote
2554
- content: &ref_142
2563
+ content: &ref_148
2555
2564
  application/json:
2556
2565
  schema:
2557
- allOf: *ref_47
2566
+ allOf: *ref_48
2558
2567
  '504':
2559
2568
  description: Timeout occurred processing the bulk quote
2560
- content: &ref_143
2569
+ content: &ref_149
2561
2570
  application/json:
2562
2571
  schema:
2563
- allOf: *ref_47
2572
+ allOf: *ref_48
2564
2573
  /bulkQuotes/{bulkQuoteId}:
2565
2574
  get:
2566
2575
  summary: Retrieves information for a specific bulk quote
@@ -2575,7 +2584,7 @@ paths:
2575
2584
  - name: bulkQuoteId
2576
2585
  in: path
2577
2586
  required: true
2578
- schema: &ref_155
2587
+ schema: &ref_161
2579
2588
  title: CorrelationId
2580
2589
  type: string
2581
2590
  pattern: >-
@@ -2599,11 +2608,11 @@ paths:
2599
2608
  application/json:
2600
2609
  schema:
2601
2610
  type: object
2602
- required: &ref_105
2611
+ required: &ref_108
2603
2612
  - bulkQuoteId
2604
2613
  - currentState
2605
2614
  - individualQuotes
2606
- properties: &ref_106
2615
+ properties: &ref_109
2607
2616
  bulkQuoteId:
2608
2617
  title: CorrelationId
2609
2618
  type: string
@@ -2621,7 +2630,7 @@ paths:
2621
2630
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
2622
2631
  currentState:
2623
2632
  type: string
2624
- enum: &ref_104
2633
+ enum: &ref_107
2625
2634
  - ERROR_OCCURRED
2626
2635
  - COMPLETED
2627
2636
  individualQuotes:
@@ -2632,8 +2641,8 @@ paths:
2632
2641
  title: IndividualQuote
2633
2642
  type: object
2634
2643
  description: Data model for the complex type 'individualQuote'.
2635
- properties: *ref_48
2636
- required: *ref_49
2644
+ properties: *ref_49
2645
+ required: *ref_50
2637
2646
  '500':
2638
2647
  description: An error occurred processing the bulk quote
2639
2648
  content:
@@ -2660,7 +2669,7 @@ paths:
2660
2669
  application/json:
2661
2670
  schema:
2662
2671
  type: object
2663
- required: &ref_107
2672
+ required: &ref_113
2664
2673
  - homeTransactionId
2665
2674
  - from
2666
2675
  - to
@@ -2670,7 +2679,7 @@ paths:
2670
2679
  - scenario
2671
2680
  - initiator
2672
2681
  - initiatorType
2673
- properties: &ref_108
2682
+ properties: &ref_114
2674
2683
  homeTransactionId:
2675
2684
  type: string
2676
2685
  description: >-
@@ -2724,15 +2733,140 @@ paths:
2724
2733
  than 18 digits in the major currency unit is not allowed.
2725
2734
  example: '123.45'
2726
2735
  scenario:
2727
- type: string
2728
- enum: *ref_5
2729
- description: Type of transaction.
2736
+ title: TransactionType
2737
+ type: object
2738
+ description: Data model for the complex type TransactionType.
2739
+ properties: &ref_53
2740
+ scenario:
2741
+ title: TransactionScenario
2742
+ type: string
2743
+ enum: &ref_110
2744
+ - DEPOSIT
2745
+ - WITHDRAWAL
2746
+ - TRANSFER
2747
+ - PAYMENT
2748
+ - REFUND
2749
+ description: >-
2750
+ Below are the allowed values for the enumeration.
2751
+
2752
+ - DEPOSIT - Used for performing a Cash-In (deposit)
2753
+ transaction. In a normal scenario, electronic funds are
2754
+ transferred from a Business account to a Consumer
2755
+ account, and physical cash is given from the Consumer to
2756
+ the Business User.
2757
+
2758
+ - WITHDRAWAL - Used for performing a Cash-Out
2759
+ (withdrawal) transaction. In a normal scenario,
2760
+ electronic funds are transferred from a Consumer’s
2761
+ account to a Business account, and physical cash is
2762
+ given from the Business User to the Consumer.
2763
+
2764
+ - TRANSFER - Used for performing a P2P (Peer to Peer, or
2765
+ Consumer to Consumer) transaction.
2766
+
2767
+ - PAYMENT - Usually used for performing a transaction
2768
+ from a Consumer to a Merchant or Organization, but could
2769
+ also be for a B2B (Business to Business) payment. The
2770
+ transaction could be online for a purchase in an
2771
+ Internet store, in a physical store where both the
2772
+ Consumer and Business User are present, a bill payment,
2773
+ a donation, and so on.
2774
+
2775
+ - REFUND - Used for performing a refund of transaction.
2776
+ example: DEPOSIT
2777
+ subScenario:
2778
+ title: TransactionSubScenario
2779
+ type: string
2780
+ pattern: ^[A-Z_]{1,32}$
2781
+ description: >-
2782
+ Possible sub-scenario, defined locally within the scheme
2783
+ (UndefinedEnum Type).
2784
+ example: LOCALLY_DEFINED_SUBSCENARIO
2785
+ initiator:
2786
+ title: TransactionInitiator
2787
+ type: string
2788
+ enum: &ref_52
2789
+ - PAYER
2790
+ - PAYEE
2791
+ description: >-
2792
+ Below are the allowed values for the enumeration.
2793
+
2794
+ - PAYER - Sender of funds is initiating the transaction.
2795
+ The account to send from is either owned by the Payer or
2796
+ is connected to the Payer in some way.
2797
+
2798
+ - PAYEE - Recipient of the funds is initiating the
2799
+ transaction by sending a transaction request. The Payer
2800
+ must approve the transaction, either automatically by a
2801
+ pre-generated OTP or by pre-approval of the Payee, or by
2802
+ manually approving in his or her own Device.
2803
+ example: PAYEE
2804
+ initiatorType:
2805
+ title: TransactionInitiatorType
2806
+ type: string
2807
+ enum: *ref_51
2808
+ description: >-
2809
+ Below are the allowed values for the enumeration.
2810
+
2811
+ - CONSUMER - Consumer is the initiator of the
2812
+ transaction.
2813
+
2814
+ - AGENT - Agent is the initiator of the transaction.
2815
+
2816
+ - BUSINESS - Business is the initiator of the
2817
+ transaction.
2818
+
2819
+ - DEVICE - Device is the initiator of the transaction.
2820
+ example: CONSUMER
2821
+ refundInfo:
2822
+ title: Refund
2823
+ type: object
2824
+ description: Data model for the complex type Refund.
2825
+ properties: &ref_111
2826
+ originalTransactionId:
2827
+ title: CorrelationId
2828
+ type: string
2829
+ pattern: >-
2830
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2831
+ description: >-
2832
+ Identifier that correlates all messages of the same
2833
+ sequence. The API data type UUID (Universally Unique
2834
+ Identifier) is a JSON String in canonical format,
2835
+ conforming to [RFC
2836
+ 4122](https://tools.ietf.org/html/rfc4122), that is
2837
+ restricted by a regular expression for
2838
+ interoperability reasons. A UUID is always 36
2839
+ characters long, 32 hexadecimal symbols and 4 dashes
2840
+ (‘-‘).
2841
+ example: b51ec534-ee48-4575-b6a9-ead2955b8069
2842
+ refundReason:
2843
+ title: RefundReason
2844
+ type: string
2845
+ minLength: 1
2846
+ maxLength: 128
2847
+ description: Reason for the refund.
2848
+ example: Free text indicating reason for the refund.
2849
+ required: &ref_112
2850
+ - originalTransactionId
2851
+ balanceOfPayments:
2852
+ title: BalanceOfPayments
2853
+ type: string
2854
+ pattern: ^[1-9]\d{2}$
2855
+ description: >-
2856
+ (BopCode) The API data type
2857
+ [BopCode](https://www.imf.org/external/np/sta/bopcode/)
2858
+ is a JSON String of 3 characters, consisting of digits
2859
+ only. Negative numbers are not allowed. A leading zero
2860
+ is not allowed.
2861
+ example: '123'
2862
+ required: &ref_54
2863
+ - scenario
2864
+ - initiator
2865
+ - initiatorType
2730
2866
  initiator:
2731
2867
  title: TransactionInitiator
2732
2868
  type: string
2733
- enum: &ref_51
2734
- - PAYER
2735
- - PAYEE
2869
+ enum: *ref_52
2736
2870
  description: >-
2737
2871
  Below are the allowed values for the enumeration.
2738
2872
 
@@ -2749,7 +2883,7 @@ paths:
2749
2883
  initiatorType:
2750
2884
  title: TransactionInitiatorType
2751
2885
  type: string
2752
- enum: *ref_50
2886
+ enum: *ref_51
2753
2887
  description: |-
2754
2888
  Below are the allowed values for the enumeration.
2755
2889
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -2761,11 +2895,11 @@ paths:
2761
2895
  responses:
2762
2896
  '200':
2763
2897
  description: Request to Pay completed successfully
2764
- content: &ref_144
2898
+ content: &ref_150
2765
2899
  application/json:
2766
2900
  schema:
2767
2901
  type: object
2768
- required: &ref_111
2902
+ required: &ref_117
2769
2903
  - transactionRequestId
2770
2904
  - from
2771
2905
  - to
@@ -2774,7 +2908,7 @@ paths:
2774
2908
  - amount
2775
2909
  - transactionType
2776
2910
  - requestToPayState
2777
- properties: &ref_112
2911
+ properties: &ref_118
2778
2912
  transactionRequestId:
2779
2913
  title: CorrelationId
2780
2914
  type: string
@@ -2840,13 +2974,15 @@ paths:
2840
2974
  not allowed.
2841
2975
  example: '123.45'
2842
2976
  scenario:
2843
- type: string
2844
- enum: *ref_5
2845
- description: Type of transaction.
2977
+ title: TransactionType
2978
+ type: object
2979
+ description: Data model for the complex type TransactionType.
2980
+ properties: *ref_53
2981
+ required: *ref_54
2846
2982
  initiator:
2847
2983
  title: TransactionInitiator
2848
2984
  type: string
2849
- enum: *ref_51
2985
+ enum: *ref_52
2850
2986
  description: >-
2851
2987
  Below are the allowed values for the enumeration.
2852
2988
 
@@ -2863,7 +2999,7 @@ paths:
2863
2999
  initiatorType:
2864
3000
  title: TransactionInitiatorType
2865
3001
  type: string
2866
- enum: *ref_50
3002
+ enum: *ref_51
2867
3003
  description: |-
2868
3004
  Below are the allowed values for the enumeration.
2869
3005
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -2874,7 +3010,7 @@ paths:
2874
3010
  authenticationType:
2875
3011
  title: AuthenticationType
2876
3012
  type: string
2877
- enum: &ref_109
3013
+ enum: &ref_115
2878
3014
  - OTP
2879
3015
  - QRCODE
2880
3016
  - U2F
@@ -2892,7 +3028,7 @@ paths:
2892
3028
  requestToPayState:
2893
3029
  title: TransactionRequestState
2894
3030
  type: string
2895
- enum: &ref_110
3031
+ enum: &ref_116
2896
3032
  - RECEIVED
2897
3033
  - PENDING
2898
3034
  - ACCEPTED
@@ -2958,7 +3094,7 @@ paths:
2958
3094
  application/json:
2959
3095
  schema:
2960
3096
  type: object
2961
- required: &ref_113
3097
+ required: &ref_119
2962
3098
  - requestToPayTransactionId
2963
3099
  - from
2964
3100
  - to
@@ -2968,7 +3104,7 @@ paths:
2968
3104
  - scenario
2969
3105
  - initiator
2970
3106
  - initiatorType
2971
- properties: &ref_114
3107
+ properties: &ref_120
2972
3108
  requestToPayTransactionId:
2973
3109
  type: string
2974
3110
  description: >-
@@ -3022,13 +3158,15 @@ paths:
3022
3158
  than 18 digits in the major currency unit is not allowed.
3023
3159
  example: '123.45'
3024
3160
  scenario:
3025
- type: string
3026
- enum: *ref_5
3027
- description: Type of transaction.
3161
+ title: TransactionType
3162
+ type: object
3163
+ description: Data model for the complex type TransactionType.
3164
+ properties: *ref_53
3165
+ required: *ref_54
3028
3166
  initiator:
3029
3167
  title: TransactionInitiator
3030
3168
  type: string
3031
- enum: *ref_51
3169
+ enum: *ref_52
3032
3170
  description: >-
3033
3171
  Below are the allowed values for the enumeration.
3034
3172
 
@@ -3045,7 +3183,7 @@ paths:
3045
3183
  initiatorType:
3046
3184
  title: TransactionInitiatorType
3047
3185
  type: string
3048
- enum: *ref_50
3186
+ enum: *ref_51
3049
3187
  description: |-
3050
3188
  Below are the allowed values for the enumeration.
3051
3189
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -3064,11 +3202,11 @@ paths:
3064
3202
  responses:
3065
3203
  '200':
3066
3204
  description: Transfer completed successfully
3067
- content: &ref_145
3205
+ content: &ref_151
3068
3206
  application/json:
3069
3207
  schema:
3070
3208
  type: object
3071
- required: &ref_115
3209
+ required: &ref_121
3072
3210
  - requestToPayTransactionId
3073
3211
  - from
3074
3212
  - to
@@ -3076,7 +3214,7 @@ paths:
3076
3214
  - currency
3077
3215
  - amount
3078
3216
  - transactionType
3079
- properties: &ref_116
3217
+ properties: &ref_122
3080
3218
  transferId:
3081
3219
  title: CorrelationId
3082
3220
  type: string
@@ -3147,6 +3285,7 @@ paths:
3147
3285
  not allowed.
3148
3286
  example: '123.45'
3149
3287
  transactionType:
3288
+ title: transferTransactionType
3150
3289
  type: string
3151
3290
  enum: *ref_5
3152
3291
  description: Type of transaction.
@@ -3179,8 +3318,8 @@ paths:
3179
3318
  title: QuotesIDPutResponse
3180
3319
  type: object
3181
3320
  description: The object sent in the PUT /quotes/{ID} callback.
3182
- properties: *ref_27
3183
- required: *ref_28
3321
+ properties: *ref_55
3322
+ required: *ref_56
3184
3323
  quoteResponseSource:
3185
3324
  type: string
3186
3325
  description: >
@@ -3202,7 +3341,7 @@ paths:
3202
3341
  properties: *ref_26
3203
3342
  '400':
3204
3343
  description: Malformed or missing required body, headers or parameters
3205
- content: &ref_146
3344
+ content: &ref_152
3206
3345
  application/json:
3207
3346
  schema:
3208
3347
  allOf: *ref_14
@@ -3237,12 +3376,12 @@ paths:
3237
3376
  schema:
3238
3377
  oneOf:
3239
3378
  - type: object
3240
- required: *ref_33
3241
- properties: *ref_34
3379
+ required: *ref_32
3380
+ properties: *ref_33
3242
3381
  - type: object
3243
- required: &ref_117
3382
+ required: &ref_123
3244
3383
  - acceptOTP
3245
- properties: &ref_118
3384
+ properties: &ref_124
3246
3385
  acceptOTP:
3247
3386
  type: boolean
3248
3387
  enum:
@@ -3252,7 +3391,7 @@ paths:
3252
3391
  - name: requestToPayTransactionId
3253
3392
  in: path
3254
3393
  required: true
3255
- schema: &ref_156
3394
+ schema: &ref_162
3256
3395
  title: CorrelationId
3257
3396
  type: string
3258
3397
  pattern: >-
@@ -3297,7 +3436,7 @@ paths:
3297
3436
  application/json:
3298
3437
  schema:
3299
3438
  type: array
3300
- items: &ref_52
3439
+ items: &ref_57
3301
3440
  type: object
3302
3441
  required:
3303
3442
  - idType
@@ -3392,13 +3531,13 @@ paths:
3392
3531
  responses:
3393
3532
  '200':
3394
3533
  description: Accounts creation completed
3395
- content: &ref_147
3534
+ content: &ref_153
3396
3535
  application/json:
3397
3536
  schema:
3398
3537
  type: object
3399
- required: &ref_53
3538
+ required: &ref_58
3400
3539
  - accounts
3401
- properties: &ref_54
3540
+ properties: &ref_59
3402
3541
  modelId:
3403
3542
  title: CorrelationId
3404
3543
  type: string
@@ -3416,10 +3555,10 @@ paths:
3416
3555
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3417
3556
  accounts:
3418
3557
  type: array
3419
- items: *ref_52
3558
+ items: *ref_57
3420
3559
  response:
3421
3560
  type: array
3422
- items: &ref_119
3561
+ items: &ref_125
3423
3562
  type: object
3424
3563
  required:
3425
3564
  - idType
@@ -3508,7 +3647,7 @@ paths:
3508
3647
  properties: *ref_22
3509
3648
  currentState:
3510
3649
  type: string
3511
- enum: &ref_120
3650
+ enum: &ref_126
3512
3651
  - ERROR_OCCURRED
3513
3652
  - COMPLETED
3514
3653
  lastError:
@@ -3528,10 +3667,10 @@ paths:
3528
3667
  type: object
3529
3668
  '400':
3530
3669
  description: An error occurred creating accounts
3531
- content: &ref_55
3670
+ content: &ref_60
3532
3671
  application/json:
3533
3672
  schema:
3534
- allOf: &ref_56
3673
+ allOf: &ref_61
3535
3674
  - type: object
3536
3675
  properties: *ref_22
3537
3676
  - type: object
@@ -3540,23 +3679,23 @@ paths:
3540
3679
  properties:
3541
3680
  executionState:
3542
3681
  type: object
3543
- required: *ref_53
3544
- properties: *ref_54
3682
+ required: *ref_58
3683
+ properties: *ref_59
3545
3684
  '500':
3546
3685
  description: An error occurred creating accounts
3547
- content: *ref_55
3686
+ content: *ref_60
3548
3687
  '504':
3549
3688
  description: Timeout occurred creating accounts
3550
- content: &ref_148
3689
+ content: &ref_154
3551
3690
  application/json:
3552
3691
  schema:
3553
- allOf: *ref_56
3692
+ allOf: *ref_61
3554
3693
  /parties/{Type}/{ID}:
3555
3694
  parameters:
3556
3695
  - name: Type
3557
3696
  in: path
3558
3697
  required: true
3559
- schema: &ref_59
3698
+ schema: &ref_64
3560
3699
  type: string
3561
3700
  description: >-
3562
3701
  The type of the party identifier. For example, `MSISDN`,
@@ -3564,7 +3703,7 @@ paths:
3564
3703
  - name: ID
3565
3704
  in: path
3566
3705
  required: true
3567
- schema: &ref_60
3706
+ schema: &ref_65
3568
3707
  type: string
3569
3708
  description: The identifier value.
3570
3709
  get:
@@ -3580,13 +3719,13 @@ paths:
3580
3719
  responses:
3581
3720
  '200':
3582
3721
  description: PartiesByIdSuccess
3583
- content: &ref_61
3722
+ content: &ref_66
3584
3723
  application/json:
3585
3724
  schema:
3586
3725
  title: partiesByIdResponse
3587
3726
  type: object
3588
3727
  description: GET /parties/{Type}/{ID} response object
3589
- properties: &ref_121
3728
+ properties: &ref_127
3590
3729
  party:
3591
3730
  properties:
3592
3731
  body:
@@ -3602,16 +3741,16 @@ paths:
3602
3741
  - headers
3603
3742
  currentState:
3604
3743
  type: string
3605
- enum: &ref_65
3744
+ enum: &ref_68
3606
3745
  - WAITING_FOR_ACTION
3607
3746
  - COMPLETED
3608
3747
  - ERROR_OCCURRED
3609
- required: &ref_122
3748
+ required: &ref_128
3610
3749
  - party
3611
3750
  - currentState
3612
3751
  '404':
3613
3752
  description: PartiesByIdError404
3614
- content: &ref_62
3753
+ content: &ref_67
3615
3754
  application/json:
3616
3755
  schema:
3617
3756
  type: object
@@ -3620,26 +3759,26 @@ paths:
3620
3759
  title: ErrorInformation
3621
3760
  type: object
3622
3761
  description: Data model for the complex type ErrorInformation.
3623
- properties: *ref_57
3624
- required: *ref_58
3762
+ properties: *ref_62
3763
+ required: *ref_63
3625
3764
  /parties/{Type}/{ID}/{SubId}:
3626
3765
  parameters:
3627
3766
  - name: Type
3628
3767
  in: path
3629
3768
  required: true
3630
- schema: *ref_59
3769
+ schema: *ref_64
3631
3770
  description: >-
3632
3771
  The type of the party identifier. For example, `MSISDN`,
3633
3772
  `PERSONAL_ID`.
3634
3773
  - name: ID
3635
3774
  in: path
3636
3775
  required: true
3637
- schema: *ref_60
3776
+ schema: *ref_65
3638
3777
  description: The identifier value.
3639
3778
  - name: SubId
3640
3779
  in: path
3641
3780
  required: true
3642
- schema: &ref_157
3781
+ schema: &ref_163
3643
3782
  type: string
3644
3783
  description: >-
3645
3784
  A sub-identifier of the party identifier, or a sub-type of the party
@@ -3657,10 +3796,10 @@ paths:
3657
3796
  responses:
3658
3797
  '200':
3659
3798
  description: PartiesByIdSuccess
3660
- content: *ref_61
3799
+ content: *ref_66
3661
3800
  '404':
3662
3801
  description: PartiesByIdError404
3663
- content: *ref_62
3802
+ content: *ref_67
3664
3803
  /quotes:
3665
3804
  post:
3666
3805
  summary: Quotes endpoint
@@ -3675,7 +3814,7 @@ paths:
3675
3814
  schema:
3676
3815
  title: simpleQuotesPostRequest
3677
3816
  type: object
3678
- properties: &ref_125
3817
+ properties: &ref_131
3679
3818
  fspId:
3680
3819
  title: FspId
3681
3820
  type: string
@@ -3686,7 +3825,7 @@ paths:
3686
3825
  title: QuotesPostRequest
3687
3826
  type: object
3688
3827
  description: The object sent in the POST /quotes request.
3689
- properties: &ref_123
3828
+ properties: &ref_129
3690
3829
  quoteId:
3691
3830
  title: CorrelationId
3692
3831
  type: string
@@ -3773,9 +3912,11 @@ paths:
3773
3912
  properties: *ref_6
3774
3913
  required: *ref_7
3775
3914
  transactionType:
3776
- type: string
3777
- enum: *ref_5
3778
- description: Type of transaction.
3915
+ title: TransactionType
3916
+ type: object
3917
+ description: Data model for the complex type TransactionType.
3918
+ properties: *ref_53
3919
+ required: *ref_54
3779
3920
  geoCode:
3780
3921
  title: GeoCode
3781
3922
  type: object
@@ -3783,8 +3924,8 @@ paths:
3783
3924
  Data model for the complex type GeoCode. Indicates the
3784
3925
  geographic location from where the transaction was
3785
3926
  initiated.
3786
- properties: *ref_63
3787
- required: *ref_64
3927
+ properties: *ref_43
3928
+ required: *ref_44
3788
3929
  note:
3789
3930
  title: Note
3790
3931
  type: string
@@ -3818,7 +3959,7 @@ paths:
3818
3959
  optional list of extensions, specific to deployment.
3819
3960
  properties: *ref_10
3820
3961
  required: *ref_11
3821
- required: &ref_124
3962
+ required: &ref_130
3822
3963
  - quoteId
3823
3964
  - transactionId
3824
3965
  - payee
@@ -3826,19 +3967,19 @@ paths:
3826
3967
  - amountType
3827
3968
  - amount
3828
3969
  - transactionType
3829
- required: &ref_126
3970
+ required: &ref_132
3830
3971
  - fspId
3831
3972
  - quotesPostRequest
3832
3973
  required: true
3833
3974
  responses:
3834
3975
  '200':
3835
3976
  description: sync response from POST /quotes
3836
- content: &ref_149
3977
+ content: &ref_155
3837
3978
  application/json:
3838
3979
  schema:
3839
3980
  title: QuotesPostResponse
3840
3981
  type: object
3841
- properties: &ref_127
3982
+ properties: &ref_133
3842
3983
  quotes:
3843
3984
  title: QuotesIDPutResponse
3844
3985
  type: object
@@ -3885,8 +4026,8 @@ paths:
3885
4026
  Data model for the complex type GeoCode. Indicates
3886
4027
  the geographic location from where the transaction
3887
4028
  was initiated.
3888
- properties: *ref_63
3889
- required: *ref_64
4029
+ properties: *ref_43
4030
+ required: *ref_44
3890
4031
  ilpPacket:
3891
4032
  title: IlpPacket
3892
4033
  type: string
@@ -3927,16 +4068,16 @@ paths:
3927
4068
  - headers
3928
4069
  currentState:
3929
4070
  type: string
3930
- enum: *ref_65
3931
- required: &ref_128
4071
+ enum: *ref_68
4072
+ required: &ref_134
3932
4073
  - quotes
3933
4074
  - currentState
3934
4075
  '500':
3935
4076
  description: An error occurred processing the quotes request
3936
- content: &ref_150
4077
+ content: &ref_156
3937
4078
  application/json:
3938
4079
  schema:
3939
- allOf: &ref_129
4080
+ allOf: &ref_135
3940
4081
  - type: object
3941
4082
  properties: *ref_22
3942
4083
  - type: object
@@ -3954,7 +4095,7 @@ paths:
3954
4095
  schema:
3955
4096
  title: SimpleTransfersPostRequest
3956
4097
  type: object
3957
- properties: &ref_132
4098
+ properties: &ref_138
3958
4099
  fspId:
3959
4100
  title: FspId
3960
4101
  type: string
@@ -3965,7 +4106,7 @@ paths:
3965
4106
  title: TransfersPostRequest
3966
4107
  type: object
3967
4108
  description: The object sent in the POST /transfers request.
3968
- properties: &ref_130
4109
+ properties: &ref_136
3969
4110
  transferId:
3970
4111
  title: CorrelationId
3971
4112
  type: string
@@ -4042,7 +4183,7 @@ paths:
4042
4183
  optional list of extensions, specific to deployment.
4043
4184
  properties: *ref_10
4044
4185
  required: *ref_11
4045
- required: &ref_131
4186
+ required: &ref_137
4046
4187
  - transferId
4047
4188
  - payeeFsp
4048
4189
  - payerFsp
@@ -4050,19 +4191,19 @@ paths:
4050
4191
  - ilpPacket
4051
4192
  - condition
4052
4193
  - expiration
4053
- required: &ref_133
4194
+ required: &ref_139
4054
4195
  - fspId
4055
4196
  - transfersPostRequest
4056
4197
  required: true
4057
4198
  responses:
4058
4199
  '200':
4059
4200
  description: sync response from POST /simpleTransfers
4060
- content: &ref_151
4201
+ content: &ref_157
4061
4202
  application/json:
4062
4203
  schema:
4063
4204
  title: SimpleTransfersPostResponse
4064
4205
  type: object
4065
- properties: &ref_134
4206
+ properties: &ref_140
4066
4207
  transfer:
4067
4208
  properties:
4068
4209
  body:
@@ -4078,16 +4219,16 @@ paths:
4078
4219
  - headers
4079
4220
  currentState:
4080
4221
  type: string
4081
- enum: *ref_65
4082
- required: &ref_135
4222
+ enum: *ref_68
4223
+ required: &ref_141
4083
4224
  - transfer
4084
4225
  - currentState
4085
4226
  '500':
4086
4227
  description: An error occurred processing the simple transfers request
4087
- content: &ref_152
4228
+ content: &ref_158
4088
4229
  application/json:
4089
4230
  schema:
4090
- allOf: &ref_136
4231
+ allOf: &ref_142
4091
4232
  - type: object
4092
4233
  properties: *ref_22
4093
4234
  - type: object
@@ -4096,7 +4237,7 @@ components:
4096
4237
  TransactionInitiatorType:
4097
4238
  title: TransactionInitiatorType
4098
4239
  type: string
4099
- enum: *ref_50
4240
+ enum: *ref_51
4100
4241
  description: |-
4101
4242
  Below are the allowed values for the enumeration.
4102
4243
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -4302,7 +4443,8 @@ components:
4302
4443
  minor currency unit; a negative value is not allowed. Using more than 18
4303
4444
  digits in the major currency unit is not allowed.
4304
4445
  example: '123.45'
4305
- TransactionType:
4446
+ transferTransactionType:
4447
+ title: transferTransactionType
4306
4448
  type: string
4307
4449
  enum: *ref_5
4308
4450
  description: Type of transaction.
@@ -4315,8 +4457,8 @@ components:
4315
4457
  example: Note sent to Payee.
4316
4458
  transferRequest:
4317
4459
  type: object
4318
- required: *ref_66
4319
- properties: *ref_67
4460
+ required: *ref_69
4461
+ properties: *ref_70
4320
4462
  CorrelationId:
4321
4463
  title: CorrelationId
4322
4464
  type: string
@@ -4378,8 +4520,8 @@ components:
4378
4520
  description: >-
4379
4521
  Data model for the complex type GeoCode. Indicates the geographic
4380
4522
  location from where the transaction was initiated.
4381
- properties: *ref_63
4382
- required: *ref_64
4523
+ properties: *ref_43
4524
+ required: *ref_44
4383
4525
  IlpPacket:
4384
4526
  title: IlpPacket
4385
4527
  type: string
@@ -4407,8 +4549,8 @@ components:
4407
4549
  title: QuotesIDPutResponse
4408
4550
  type: object
4409
4551
  description: The object sent in the PUT /quotes/{ID} callback.
4410
- properties: *ref_27
4411
- required: *ref_28
4552
+ properties: *ref_55
4553
+ required: *ref_56
4412
4554
  IlpFulfilment:
4413
4555
  title: IlpFulfilment
4414
4556
  type: string
@@ -4419,7 +4561,7 @@ components:
4419
4561
  TransferState:
4420
4562
  title: TransferState
4421
4563
  type: string
4422
- enum: *ref_68
4564
+ enum: *ref_27
4423
4565
  description: >-
4424
4566
  Below are the allowed values for the enumeration.
4425
4567
 
@@ -4461,11 +4603,11 @@ components:
4461
4603
  title: ErrorInformation
4462
4604
  type: object
4463
4605
  description: Data model for the complex type ErrorInformation.
4464
- properties: *ref_57
4465
- required: *ref_58
4606
+ properties: *ref_62
4607
+ required: *ref_63
4466
4608
  mojaloopError:
4467
4609
  type: object
4468
- properties: *ref_37
4610
+ properties: *ref_36
4469
4611
  transferError:
4470
4612
  type: object
4471
4613
  description: >-
@@ -4483,40 +4625,40 @@ components:
4483
4625
  allOf: *ref_14
4484
4626
  transferStatusResponse:
4485
4627
  type: object
4486
- required: *ref_69
4487
- properties: *ref_70
4628
+ required: *ref_71
4629
+ properties: *ref_72
4488
4630
  transferContinuationAcceptParty:
4489
4631
  type: object
4490
- required: *ref_29
4491
- properties: *ref_30
4632
+ required: *ref_28
4633
+ properties: *ref_29
4492
4634
  transferContinuationAcceptQuote:
4493
4635
  type: object
4494
- required: *ref_33
4495
- properties: *ref_34
4636
+ required: *ref_32
4637
+ properties: *ref_33
4496
4638
  autoAcceptPartyOption:
4497
- type: object
4498
- required: *ref_71
4499
- properties: *ref_72
4500
- bulkPerTransferFeeLimit:
4501
4639
  type: object
4502
4640
  required: *ref_73
4503
4641
  properties: *ref_74
4504
- autoAcceptQuote:
4642
+ bulkPerTransferFeeLimit:
4505
4643
  type: object
4506
4644
  required: *ref_75
4507
4645
  properties: *ref_76
4508
- bulkTransactionOptions:
4646
+ autoAcceptQuote:
4509
4647
  type: object
4510
4648
  required: *ref_77
4511
4649
  properties: *ref_78
4650
+ bulkTransactionOptions:
4651
+ type: object
4652
+ required: *ref_79
4653
+ properties: *ref_80
4512
4654
  PartyIdInfo:
4513
4655
  title: PartyIdInfo
4514
4656
  type: object
4515
4657
  description: >-
4516
4658
  Data model for the complex type PartyIdInfo. An ExtensionList element
4517
4659
  has been added to this reqeust in version v1.1
4518
- properties: *ref_79
4519
- required: *ref_80
4660
+ properties: *ref_81
4661
+ required: *ref_82
4520
4662
  PartyName:
4521
4663
  title: PartyName
4522
4664
  type: string
@@ -4527,12 +4669,12 @@ components:
4527
4669
  title: PartyComplexName
4528
4670
  type: object
4529
4671
  description: Data model for the complex type PartyComplexName.
4530
- properties: *ref_81
4672
+ properties: *ref_83
4531
4673
  PartyPersonalInfo:
4532
4674
  title: PartyPersonalInfo
4533
4675
  type: object
4534
4676
  description: Data model for the complex type PartyPersonalInfo.
4535
- properties: *ref_82
4677
+ properties: *ref_84
4536
4678
  Party:
4537
4679
  title: Party
4538
4680
  type: object
@@ -4543,110 +4685,147 @@ components:
4543
4685
  title: IndividualTransaction
4544
4686
  type: object
4545
4687
  description: Data model for the complex type 'individualTransaction'.
4546
- properties: *ref_83
4547
- required: *ref_84
4688
+ properties: *ref_85
4689
+ required: *ref_86
4548
4690
  bulkTransactionRequest:
4549
- type: object
4550
- required: *ref_85
4551
- properties: *ref_86
4552
- individualTransferResult:
4553
4691
  type: object
4554
4692
  required: *ref_87
4555
4693
  properties: *ref_88
4694
+ individualTransferResult:
4695
+ type: object
4696
+ required: *ref_89
4697
+ properties: *ref_90
4556
4698
  bulkTransferResponse:
4557
4699
  type: object
4558
- required: *ref_40
4559
- properties: *ref_41
4700
+ required: *ref_39
4701
+ properties: *ref_40
4560
4702
  bulkTransferErrorResponse:
4561
- allOf: *ref_89
4703
+ allOf: *ref_91
4562
4704
  individualTransactionAccept:
4563
4705
  type: object
4564
4706
  description: Data model for the 'individualTransfer' while accepting party or quote.
4565
- properties: *ref_31
4566
- required: *ref_32
4707
+ properties: *ref_30
4708
+ required: *ref_31
4567
4709
  bulkTransactionContinuationAcceptParty:
4568
4710
  description: >-
4569
4711
  The object sent back as confirmation of payee parties when
4570
4712
  autoAcceptParty is false.
4571
4713
  type: object
4572
- required: *ref_35
4573
- properties: *ref_36
4714
+ required: *ref_34
4715
+ properties: *ref_35
4574
4716
  bulkTransactionContinuationAcceptQuote:
4575
4717
  description: >-
4576
4718
  The object sent back as confirmation of quotes when autoAcceptQuotes is
4577
4719
  false.
4578
4720
  type: object
4579
- required: *ref_38
4580
- properties: *ref_39
4721
+ required: *ref_37
4722
+ properties: *ref_38
4581
4723
  partyError:
4582
4724
  type: object
4583
4725
  description: >-
4584
4726
  This object represents a Mojaloop API error received at any time during
4585
4727
  the party discovery process
4586
- properties: *ref_90
4728
+ properties: *ref_92
4587
4729
  bulkTransactionAcceptPartyErrorResponse:
4588
- allOf: *ref_91
4730
+ allOf: *ref_93
4589
4731
  quoteError:
4590
4732
  type: object
4591
4733
  description: >-
4592
4734
  This object represents a Mojaloop API error received at any time during
4593
4735
  the quote process
4594
- properties: *ref_44
4736
+ properties: *ref_45
4595
4737
  bulkTransactionAcceptQuoteErrorResponse:
4596
- allOf: *ref_92
4738
+ allOf: *ref_94
4597
4739
  individualTransfer:
4598
4740
  title: IndividualTransfer
4599
4741
  type: object
4600
4742
  description: Data model for the complex type 'individualTransfer'.
4601
- properties: *ref_93
4602
- required: *ref_94
4743
+ properties: *ref_95
4744
+ required: *ref_96
4603
4745
  bulkTransferRequest:
4604
4746
  type: object
4605
- required: *ref_95
4606
- properties: *ref_96
4747
+ required: *ref_97
4748
+ properties: *ref_98
4607
4749
  bulkTransferStatus:
4608
4750
  type: string
4609
- enum: *ref_97
4751
+ enum: *ref_99
4610
4752
  individualTransferFulfilment:
4611
4753
  type: object
4612
4754
  description: >-
4613
4755
  A Mojaloop API transfer fulfilment for individual transfers in a bulk
4614
4756
  transfer
4615
- properties: *ref_98
4757
+ properties: *ref_100
4616
4758
  bulkTransferStatusResponse:
4617
4759
  type: object
4618
- required: *ref_99
4619
- properties: *ref_100
4760
+ required: *ref_101
4761
+ properties: *ref_102
4620
4762
  individualQuote:
4621
4763
  title: IndividualQuote
4622
4764
  type: object
4623
4765
  description: Data model for the complex type 'individualQuote'.
4624
- properties: *ref_48
4625
- required: *ref_49
4766
+ properties: *ref_49
4767
+ required: *ref_50
4626
4768
  bulkQuoteRequest:
4627
4769
  type: object
4628
- required: *ref_101
4629
- properties: *ref_102
4770
+ required: *ref_103
4771
+ properties: *ref_104
4630
4772
  individualQuoteResult:
4631
4773
  type: object
4632
- properties: *ref_103
4774
+ properties: *ref_105
4775
+ required: *ref_106
4633
4776
  bulkQuoteResponse:
4634
4777
  type: object
4635
- required: *ref_45
4636
- properties: *ref_46
4778
+ required: *ref_46
4779
+ properties: *ref_47
4637
4780
  bulkQuoteErrorResponse:
4638
- allOf: *ref_47
4781
+ allOf: *ref_48
4639
4782
  bulkQuoteStatus:
4640
4783
  type: string
4641
- enum: *ref_104
4784
+ enum: *ref_107
4642
4785
  bulkQuoteStatusResponse:
4643
4786
  type: object
4644
- required: *ref_105
4645
- properties: *ref_106
4787
+ required: *ref_108
4788
+ properties: *ref_109
4789
+ TransactionScenario:
4790
+ title: TransactionScenario
4791
+ type: string
4792
+ enum: *ref_110
4793
+ description: >-
4794
+ Below are the allowed values for the enumeration.
4795
+
4796
+ - DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a
4797
+ normal scenario, electronic funds are transferred from a Business
4798
+ account to a Consumer account, and physical cash is given from the
4799
+ Consumer to the Business User.
4800
+
4801
+ - WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction.
4802
+ In a normal scenario, electronic funds are transferred from a Consumer’s
4803
+ account to a Business account, and physical cash is given from the
4804
+ Business User to the Consumer.
4805
+
4806
+ - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to
4807
+ Consumer) transaction.
4808
+
4809
+ - PAYMENT - Usually used for performing a transaction from a Consumer to
4810
+ a Merchant or Organization, but could also be for a B2B (Business to
4811
+ Business) payment. The transaction could be online for a purchase in an
4812
+ Internet store, in a physical store where both the Consumer and Business
4813
+ User are present, a bill payment, a donation, and so on.
4814
+
4815
+ - REFUND - Used for performing a refund of transaction.
4816
+ example: DEPOSIT
4817
+ TransactionSubScenario:
4818
+ title: TransactionSubScenario
4819
+ type: string
4820
+ pattern: ^[A-Z_]{1,32}$
4821
+ description: >-
4822
+ Possible sub-scenario, defined locally within the scheme (UndefinedEnum
4823
+ Type).
4824
+ example: LOCALLY_DEFINED_SUBSCENARIO
4646
4825
  TransactionInitiator:
4647
4826
  title: TransactionInitiator
4648
4827
  type: string
4649
- enum: *ref_51
4828
+ enum: *ref_52
4650
4829
  description: >-
4651
4830
  Below are the allowed values for the enumeration.
4652
4831
 
@@ -4659,14 +4838,43 @@ components:
4659
4838
  either automatically by a pre-generated OTP or by pre-approval of the
4660
4839
  Payee, or by manually approving in his or her own Device.
4661
4840
  example: PAYEE
4841
+ RefundReason:
4842
+ title: RefundReason
4843
+ type: string
4844
+ minLength: 1
4845
+ maxLength: 128
4846
+ description: Reason for the refund.
4847
+ example: Free text indicating reason for the refund.
4848
+ Refund:
4849
+ title: Refund
4850
+ type: object
4851
+ description: Data model for the complex type Refund.
4852
+ properties: *ref_111
4853
+ required: *ref_112
4854
+ BalanceOfPayments:
4855
+ title: BalanceOfPayments
4856
+ type: string
4857
+ pattern: ^[1-9]\d{2}$
4858
+ description: >-
4859
+ (BopCode) The API data type
4860
+ [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String
4861
+ of 3 characters, consisting of digits only. Negative numbers are not
4862
+ allowed. A leading zero is not allowed.
4863
+ example: '123'
4864
+ TransactionType:
4865
+ title: TransactionType
4866
+ type: object
4867
+ description: Data model for the complex type TransactionType.
4868
+ properties: *ref_53
4869
+ required: *ref_54
4662
4870
  requestToPayRequest:
4663
4871
  type: object
4664
- required: *ref_107
4665
- properties: *ref_108
4872
+ required: *ref_113
4873
+ properties: *ref_114
4666
4874
  AuthenticationType:
4667
4875
  title: AuthenticationType
4668
4876
  type: string
4669
- enum: *ref_109
4877
+ enum: *ref_115
4670
4878
  description: |-
4671
4879
  Below are the allowed values for the enumeration AuthenticationType.
4672
4880
  - OTP - One-time password generated by the Payer FSP.
@@ -4676,7 +4884,7 @@ components:
4676
4884
  TransactionRequestState:
4677
4885
  title: TransactionRequestState
4678
4886
  type: string
4679
- enum: *ref_110
4887
+ enum: *ref_116
4680
4888
  description: |-
4681
4889
  Below are the allowed values for the enumeration.
4682
4890
  - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
@@ -4686,87 +4894,87 @@ components:
4686
4894
  example: RECEIVED
4687
4895
  requestToPayResponse:
4688
4896
  type: object
4689
- required: *ref_111
4690
- properties: *ref_112
4897
+ required: *ref_117
4898
+ properties: *ref_118
4691
4899
  requestToPayTransferRequest:
4692
4900
  type: object
4693
- required: *ref_113
4694
- properties: *ref_114
4901
+ required: *ref_119
4902
+ properties: *ref_120
4695
4903
  requestToPayTransferResponse:
4696
4904
  type: object
4697
- required: *ref_115
4698
- properties: *ref_116
4905
+ required: *ref_121
4906
+ properties: *ref_122
4699
4907
  transferContinuationAcceptOTP:
4700
4908
  type: object
4701
- required: *ref_117
4702
- properties: *ref_118
4909
+ required: *ref_123
4910
+ properties: *ref_124
4703
4911
  accountsRequest:
4704
4912
  type: array
4705
- items: *ref_52
4913
+ items: *ref_57
4706
4914
  accountCreationStatus:
4707
4915
  type: array
4708
- items: *ref_119
4916
+ items: *ref_125
4709
4917
  accountsCreationState:
4710
4918
  type: string
4711
- enum: *ref_120
4919
+ enum: *ref_126
4712
4920
  accountsResponse:
4713
4921
  type: object
4714
- required: *ref_53
4715
- properties: *ref_54
4922
+ required: *ref_58
4923
+ properties: *ref_59
4716
4924
  errorAccountsResponse:
4717
- allOf: *ref_56
4925
+ allOf: *ref_61
4718
4926
  async2SyncCurrentState:
4719
4927
  type: string
4720
- enum: *ref_65
4928
+ enum: *ref_68
4721
4929
  partiesByIdResponse:
4722
4930
  title: partiesByIdResponse
4723
4931
  type: object
4724
4932
  description: GET /parties/{Type}/{ID} response object
4725
- properties: *ref_121
4726
- required: *ref_122
4933
+ properties: *ref_127
4934
+ required: *ref_128
4727
4935
  QuotesPostRequest:
4728
4936
  title: QuotesPostRequest
4729
4937
  type: object
4730
4938
  description: The object sent in the POST /quotes request.
4731
- properties: *ref_123
4732
- required: *ref_124
4939
+ properties: *ref_129
4940
+ required: *ref_130
4733
4941
  simpleQuotesPostRequest:
4734
4942
  title: simpleQuotesPostRequest
4735
4943
  type: object
4736
- properties: *ref_125
4737
- required: *ref_126
4944
+ properties: *ref_131
4945
+ required: *ref_132
4738
4946
  quotesPostResponse:
4739
4947
  title: QuotesPostResponse
4740
4948
  type: object
4741
- properties: *ref_127
4742
- required: *ref_128
4949
+ properties: *ref_133
4950
+ required: *ref_134
4743
4951
  errorQuotesResponse:
4744
- allOf: *ref_129
4952
+ allOf: *ref_135
4745
4953
  TransfersPostRequest:
4746
4954
  title: TransfersPostRequest
4747
4955
  type: object
4748
4956
  description: The object sent in the POST /transfers request.
4749
- properties: *ref_130
4750
- required: *ref_131
4957
+ properties: *ref_136
4958
+ required: *ref_137
4751
4959
  simpleTransfersPostRequest:
4752
4960
  title: SimpleTransfersPostRequest
4753
4961
  type: object
4754
- properties: *ref_132
4755
- required: *ref_133
4962
+ properties: *ref_138
4963
+ required: *ref_139
4756
4964
  simpleTransfersPostResponse:
4757
4965
  title: SimpleTransfersPostResponse
4758
4966
  type: object
4759
- properties: *ref_134
4760
- required: *ref_135
4967
+ properties: *ref_140
4968
+ required: *ref_141
4761
4969
  errorSimpleTransfersResponse:
4762
- allOf: *ref_136
4970
+ allOf: *ref_142
4763
4971
  responses:
4764
4972
  transferSuccess:
4765
4973
  description: Transfer completed successfully
4766
4974
  content: *ref_15
4767
4975
  transferBadRequest:
4768
4976
  description: Malformed or missing required body, headers or parameters
4769
- content: *ref_137
4977
+ content: *ref_143
4770
4978
  transferServerError:
4771
4979
  description: An error occurred processing the transfer
4772
4980
  content: *ref_16
@@ -4777,64 +4985,64 @@ components:
4777
4985
  description: Bulk transfer accepted successfully
4778
4986
  bulkTransferBadRequest:
4779
4987
  description: Malformed or missing required body, headers or parameters
4780
- content: *ref_42
4988
+ content: *ref_41
4781
4989
  errorResponse:
4782
4990
  description: Internal Server Error
4783
- content: *ref_43
4991
+ content: *ref_42
4784
4992
  bulkTransactionPutBadRequest:
4785
4993
  description: Malformed or missing required body, headers or parameters
4786
- content: *ref_138
4994
+ content: *ref_144
4787
4995
  bulkTransferSuccess:
4788
4996
  description: Bulk transfer completed successfully
4789
- content: *ref_139
4997
+ content: *ref_145
4790
4998
  bulkQuoteSuccess:
4791
4999
  description: Bulk quote completed successfully
4792
- content: *ref_140
5000
+ content: *ref_146
4793
5001
  bulkQuoteBadRequest:
4794
5002
  description: Malformed or missing required body, headers or parameters
4795
- content: *ref_141
5003
+ content: *ref_147
4796
5004
  bulkQuoteServerError:
4797
5005
  description: An error occurred processing the bulk quote
4798
- content: *ref_142
5006
+ content: *ref_148
4799
5007
  bulkQuoteTimeout:
4800
5008
  description: Timeout occurred processing the bulk quote
4801
- content: *ref_143
5009
+ content: *ref_149
4802
5010
  requestToPaySuccess:
4803
5011
  description: Request to Pay completed successfully
4804
- content: *ref_144
5012
+ content: *ref_150
4805
5013
  requestToPayTransferSuccess:
4806
5014
  description: Transfer completed successfully
4807
- content: *ref_145
5015
+ content: *ref_151
4808
5016
  requestToPayTransferBadRequest:
4809
5017
  description: Malformed or missing required body, headers or parameters
4810
- content: *ref_146
5018
+ content: *ref_152
4811
5019
  accountsCreationCompleted:
4812
5020
  description: Accounts creation completed
4813
- content: *ref_147
5021
+ content: *ref_153
4814
5022
  accountsCreationError:
4815
5023
  description: An error occurred creating accounts
4816
- content: *ref_55
5024
+ content: *ref_60
4817
5025
  accountsCreationTimeout:
4818
5026
  description: Timeout occurred creating accounts
4819
- content: *ref_148
5027
+ content: *ref_154
4820
5028
  partiesByIdSuccess:
4821
5029
  description: PartiesByIdSuccess
4822
- content: *ref_61
5030
+ content: *ref_66
4823
5031
  partiesByIdError404:
4824
5032
  description: PartiesByIdError404
4825
- content: *ref_62
5033
+ content: *ref_67
4826
5034
  quotesPostSuccess:
4827
5035
  description: sync response from POST /quotes
4828
- content: *ref_149
5036
+ content: *ref_155
4829
5037
  quotesServerError:
4830
5038
  description: An error occurred processing the quotes request
4831
- content: *ref_150
5039
+ content: *ref_156
4832
5040
  simpleTransfersPostSuccess:
4833
5041
  description: sync response from POST /simpleTransfers
4834
- content: *ref_151
5042
+ content: *ref_157
4835
5043
  simpleTransfersServerError:
4836
5044
  description: An error occurred processing the simple transfers request
4837
- content: *ref_152
5045
+ content: *ref_158
4838
5046
  parameters:
4839
5047
  transferId:
4840
5048
  name: transferId
@@ -4848,7 +5056,7 @@ components:
4848
5056
  name: bulkTransactionId
4849
5057
  in: path
4850
5058
  required: true
4851
- schema: *ref_153
5059
+ schema: *ref_159
4852
5060
  description: >-
4853
5061
  Identifier of the bulk transaction to continue as returned in the
4854
5062
  response to a `POST /bulkTransaction` request.
@@ -4856,7 +5064,7 @@ components:
4856
5064
  name: bulkTransferId
4857
5065
  in: path
4858
5066
  required: true
4859
- schema: *ref_154
5067
+ schema: *ref_160
4860
5068
  description: >-
4861
5069
  Identifier of the bulk transfer to continue as returned in the response
4862
5070
  to a `POST /bulkTransfers` request.
@@ -4864,7 +5072,7 @@ components:
4864
5072
  name: bulkQuoteId
4865
5073
  in: path
4866
5074
  required: true
4867
- schema: *ref_155
5075
+ schema: *ref_161
4868
5076
  description: >-
4869
5077
  Identifier of the bulk transfer to continue as returned in the response
4870
5078
  to a `POST /bulkTransfers` request.
@@ -4872,7 +5080,7 @@ components:
4872
5080
  name: requestToPayTransactionId
4873
5081
  in: path
4874
5082
  required: true
4875
- schema: *ref_156
5083
+ schema: *ref_162
4876
5084
  description: >-
4877
5085
  Identifier of the merchant request to pay transfer to continue as
4878
5086
  returned in the response to a `POST /requestToPayTransfer` request.
@@ -4880,19 +5088,19 @@ components:
4880
5088
  name: Type
4881
5089
  in: path
4882
5090
  required: true
4883
- schema: *ref_59
5091
+ schema: *ref_64
4884
5092
  description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
4885
5093
  ID:
4886
5094
  name: ID
4887
5095
  in: path
4888
5096
  required: true
4889
- schema: *ref_60
5097
+ schema: *ref_65
4890
5098
  description: The identifier value.
4891
5099
  SubId:
4892
5100
  name: SubId
4893
5101
  in: path
4894
5102
  required: true
4895
- schema: *ref_157
5103
+ schema: *ref_163
4896
5104
  description: >-
4897
5105
  A sub-identifier of the party identifier, or a sub-type of the party
4898
5106
  identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.