@mojaloop/api-snippets 14.2.2 → 14.2.4

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 (19) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +669 -682
  3. package/lib/sdk-scheme-adapter/outbound/v2_0_0/json-schemas.json +4224 -6877
  4. package/lib/sdk-scheme-adapter/outbound/v2_0_0/openapi.d.ts +14415 -18040
  5. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.d.ts +765 -2179
  6. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.js +8 -8
  7. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.js.map +1 -1
  8. package/lib/sdk-scheme-adapter/outbound/v2_0_0/types.d.ts +8 -8
  9. package/package.json +15 -15
  10. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkQuoteResponse.yaml +9 -4
  11. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionRequest.yaml +1 -0
  12. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferResponse.yaml +18 -4
  13. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuote.yaml +1 -0
  14. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuoteResult.yaml +23 -12
  15. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransaction.yaml +4 -1
  16. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransactionAccept.yaml +4 -1
  17. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransactionResult.yaml +4 -1
  18. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransfer.yaml +1 -1
  19. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransferResult.yaml +8 -29
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_68
82
+ required: &ref_70
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_69
90
+ properties: &ref_71
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_40
105
+ enum: &ref_52
106
106
  - CONSUMER
107
107
  - AGENT
108
108
  - BUSINESS
@@ -677,7 +677,7 @@ paths:
677
677
  title: QuotesIDPutResponse
678
678
  type: object
679
679
  description: The object sent in the PUT /quotes/{ID} callback.
680
- properties: &ref_27
680
+ properties: &ref_56
681
681
  transferAmount:
682
682
  title: Money
683
683
  type: object
@@ -758,7 +758,7 @@ paths:
758
758
  Data model for the complex type GeoCode. Indicates
759
759
  the geographic location from where the transaction
760
760
  was initiated.
761
- properties: &ref_65
761
+ properties: &ref_44
762
762
  latitude:
763
763
  title: Latitude
764
764
  type: string
@@ -781,7 +781,7 @@ paths:
781
781
  regular expression for interoperability
782
782
  reasons.
783
783
  example: '+75.6972'
784
- required: &ref_66
784
+ required: &ref_45
785
785
  - latitude
786
786
  - longitude
787
787
  ilpPacket:
@@ -824,7 +824,7 @@ paths:
824
824
  description: Number of Extension elements.
825
825
  required: &ref_11
826
826
  - extension
827
- required: &ref_28
827
+ required: &ref_57
828
828
  - transferAmount
829
829
  - expiration
830
830
  - ilpPacket
@@ -878,7 +878,7 @@ paths:
878
878
  transferState:
879
879
  title: TransferState
880
880
  type: string
881
- enum: &ref_70
881
+ enum: &ref_27
882
882
  - RECEIVED
883
883
  - RESERVED
884
884
  - COMMITTED
@@ -931,12 +931,12 @@ paths:
931
931
  property will contain the underlying Mojaloop API
932
932
  error object.
933
933
  type: object
934
- properties: &ref_37
934
+ properties: &ref_36
935
935
  errorInformation:
936
936
  title: ErrorInformation
937
937
  type: object
938
938
  description: Data model for the complex type ErrorInformation.
939
- properties: &ref_59
939
+ properties: &ref_63
940
940
  errorCode:
941
941
  title: ErrorCode
942
942
  type: string
@@ -969,7 +969,7 @@ paths:
969
969
  deployment.
970
970
  properties: *ref_10
971
971
  required: *ref_11
972
- required: &ref_60
972
+ required: &ref_64
973
973
  - errorCode
974
974
  - errorDescription
975
975
  skipPartyLookup:
@@ -980,7 +980,7 @@ paths:
980
980
  type: boolean
981
981
  '400':
982
982
  description: Malformed or missing required body, headers or parameters
983
- content: &ref_142
983
+ content: &ref_143
984
984
  application/json:
985
985
  schema:
986
986
  allOf: &ref_14
@@ -1038,17 +1038,17 @@ paths:
1038
1038
  schema:
1039
1039
  oneOf:
1040
1040
  - type: object
1041
- required: &ref_29
1041
+ required: &ref_28
1042
1042
  - acceptParty
1043
- properties: &ref_30
1043
+ properties: &ref_29
1044
1044
  acceptParty:
1045
1045
  type: boolean
1046
1046
  enum:
1047
1047
  - true
1048
1048
  - type: object
1049
- required: &ref_33
1049
+ required: &ref_32
1050
1050
  - acceptQuote
1051
- properties: &ref_34
1051
+ properties: &ref_33
1052
1052
  acceptQuote:
1053
1053
  type: boolean
1054
1054
  enum:
@@ -1109,11 +1109,11 @@ paths:
1109
1109
  application/json:
1110
1110
  schema:
1111
1111
  type: object
1112
- required: &ref_71
1112
+ required: &ref_72
1113
1113
  - transferId
1114
1114
  - currentState
1115
1115
  - fulfil
1116
- properties: &ref_72
1116
+ properties: &ref_73
1117
1117
  transferId:
1118
1118
  title: CorrelationId
1119
1119
  type: string
@@ -1166,12 +1166,13 @@ paths:
1166
1166
  application/json:
1167
1167
  schema:
1168
1168
  type: object
1169
- required: &ref_87
1169
+ required: &ref_88
1170
+ - bulkTransactionId
1170
1171
  - bulkHomeTransactionID
1171
1172
  - options
1172
1173
  - from
1173
1174
  - individualTransfers
1174
- properties: &ref_88
1175
+ properties: &ref_89
1175
1176
  bulkHomeTransactionID:
1176
1177
  type: string
1177
1178
  description: >-
@@ -1193,11 +1194,11 @@ paths:
1193
1194
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1194
1195
  options:
1195
1196
  type: object
1196
- required: &ref_79
1197
+ required: &ref_80
1197
1198
  - autoAcceptParty
1198
1199
  - autoAcceptQuote
1199
1200
  - bulkExpiration
1200
- properties: &ref_80
1201
+ properties: &ref_81
1201
1202
  onlyValidateParty:
1202
1203
  description: >-
1203
1204
  Set to true if only party validation is required. This
@@ -1206,9 +1207,9 @@ paths:
1206
1207
  type: boolean
1207
1208
  autoAcceptParty:
1208
1209
  type: object
1209
- required: &ref_73
1210
+ required: &ref_74
1210
1211
  - enabled
1211
- properties: &ref_74
1212
+ properties: &ref_75
1212
1213
  enabled:
1213
1214
  type: boolean
1214
1215
  enum:
@@ -1223,9 +1224,9 @@ paths:
1223
1224
  type: object
1224
1225
  oneOf:
1225
1226
  - type: object
1226
- required: &ref_77
1227
+ required: &ref_78
1227
1228
  - enabled
1228
- properties: &ref_78
1229
+ properties: &ref_79
1229
1230
  enabled:
1230
1231
  type: boolean
1231
1232
  enum:
@@ -1236,10 +1237,10 @@ paths:
1236
1237
  minItems: 0
1237
1238
  items:
1238
1239
  type: object
1239
- required: &ref_75
1240
+ required: &ref_76
1240
1241
  - currency
1241
1242
  - amount
1242
- properties: &ref_76
1243
+ properties: &ref_77
1243
1244
  currency:
1244
1245
  title: Currency
1245
1246
  description: >-
@@ -1313,7 +1314,7 @@ paths:
1313
1314
  Data model for the complex type PartyIdInfo. An
1314
1315
  ExtensionList element has been added to this reqeust in
1315
1316
  version v1.1
1316
- properties: &ref_81
1317
+ properties: &ref_82
1317
1318
  partyIdType:
1318
1319
  title: PartyIdType
1319
1320
  type: string
@@ -1406,7 +1407,7 @@ paths:
1406
1407
  optional list of extensions, specific to deployment.
1407
1408
  properties: *ref_10
1408
1409
  required: *ref_11
1409
- required: &ref_82
1410
+ required: &ref_83
1410
1411
  - partyIdType
1411
1412
  - partyIdentifier
1412
1413
  merchantClassificationCode:
@@ -1428,12 +1429,12 @@ paths:
1428
1429
  title: PartyPersonalInfo
1429
1430
  type: object
1430
1431
  description: Data model for the complex type PartyPersonalInfo.
1431
- properties: &ref_84
1432
+ properties: &ref_85
1432
1433
  complexName:
1433
1434
  title: PartyComplexName
1434
1435
  type: object
1435
1436
  description: Data model for the complex type PartyComplexName.
1436
- properties: &ref_83
1437
+ properties: &ref_84
1437
1438
  firstName:
1438
1439
  title: FirstName
1439
1440
  type: string
@@ -1482,23 +1483,13 @@ paths:
1482
1483
  title: IndividualTransaction
1483
1484
  type: object
1484
1485
  description: Data model for the complex type 'individualTransaction'.
1485
- properties: &ref_85
1486
+ properties: &ref_86
1486
1487
  homeTransactionId:
1487
- title: CorrelationId
1488
1488
  type: string
1489
- pattern: >-
1490
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1491
1489
  description: >-
1492
- Identifier that correlates all messages of the same
1493
- sequence. The API data type UUID (Universally Unique
1494
- Identifier) is a JSON String in canonical format,
1495
- conforming to [RFC
1496
- 4122](https://tools.ietf.org/html/rfc4122), that is
1497
- restricted by a regular expression for
1498
- interoperability reasons. A UUID is always 36
1499
- characters long, 32 hexadecimal symbols and 4 dashes
1500
- (‘-‘).
1501
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1490
+ Transaction ID from the DFSP backend, used to
1491
+ reconcile transactions between the Switch and DFSP
1492
+ backend systems.
1502
1493
  to:
1503
1494
  title: Party
1504
1495
  type: object
@@ -1578,7 +1569,7 @@ paths:
1578
1569
  This object represents a Mojaloop API error received
1579
1570
  at any time during the transfer process
1580
1571
  properties: *ref_26
1581
- required: &ref_86
1572
+ required: &ref_87
1582
1573
  - homeTransactionId
1583
1574
  - to
1584
1575
  - amountType
@@ -1598,10 +1589,10 @@ paths:
1598
1589
  description: Bulk transfer accepted successfully
1599
1590
  '400':
1600
1591
  description: Malformed or missing required body, headers or parameters
1601
- content: &ref_43
1592
+ content: &ref_41
1602
1593
  application/json:
1603
1594
  schema:
1604
- allOf: &ref_91
1595
+ allOf: &ref_92
1605
1596
  - type: object
1606
1597
  properties: *ref_22
1607
1598
  - type: object
@@ -1610,11 +1601,28 @@ paths:
1610
1601
  properties:
1611
1602
  bulkTransferState:
1612
1603
  type: object
1613
- required: &ref_41
1614
- - from
1604
+ required: &ref_39
1605
+ - bulkTransferId
1615
1606
  - individualTransferResults
1616
- properties: &ref_42
1617
- transferId:
1607
+ - currentState
1608
+ properties: &ref_40
1609
+ bulkTransferId:
1610
+ title: CorrelationId
1611
+ type: string
1612
+ pattern: >-
1613
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1614
+ description: >-
1615
+ Identifier that correlates all messages of the
1616
+ same sequence. The API data type UUID (Universally
1617
+ Unique Identifier) is a JSON String in canonical
1618
+ format, conforming to [RFC
1619
+ 4122](https://tools.ietf.org/html/rfc4122), that
1620
+ is restricted by a regular expression for
1621
+ interoperability reasons. A UUID is always 36
1622
+ characters long, 32 hexadecimal symbols and 4
1623
+ dashes (‘-‘).
1624
+ example: b51ec534-ee48-4575-b6a9-ead2955b8069
1625
+ bulkQuoteId:
1618
1626
  title: CorrelationId
1619
1627
  type: string
1620
1628
  pattern: >-
@@ -1630,22 +1638,72 @@ paths:
1630
1638
  characters long, 32 hexadecimal symbols and 4
1631
1639
  dashes (‘-‘).
1632
1640
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1633
- from:
1641
+ homeTransactionId:
1642
+ type: string
1643
+ description: >-
1644
+ Transaction ID from the DFSP backend, used to
1645
+ reconcile transactions between the Switch and DFSP
1646
+ backend systems.
1647
+ bulkTransferState:
1648
+ title: TransferState
1649
+ type: string
1650
+ enum: *ref_27
1651
+ description: >-
1652
+ Below are the allowed values for the enumeration.
1653
+
1654
+ - RECEIVED - Next ledger has received the
1655
+ transfer.
1656
+
1657
+ - RESERVED - Next ledger has reserved the
1658
+ transfer.
1659
+
1660
+ - COMMITTED - Next ledger has successfully
1661
+ performed the transfer.
1662
+
1663
+ - ABORTED - Next ledger has aborted the transfer
1664
+ due to a rejection or failure to perform the
1665
+ transfer.
1666
+ example: RESERVED
1667
+ completedTimestamp:
1668
+ title: DateTime
1669
+ type: string
1670
+ pattern: >-
1671
+ ^(?:[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)$
1672
+ description: >-
1673
+ The API data type DateTime is a JSON String in a
1674
+ lexical format that is restricted by a regular
1675
+ expression for interoperability reasons. The
1676
+ format is according to [ISO
1677
+ 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
1678
+ expressed in a combined date, time and time zone
1679
+ format. A more readable version of the format is
1680
+ yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
1681
+ "2016-05-24T08:38:08.699-04:00",
1682
+ "2016-05-24T08:38:08.699Z" (where Z indicates Zulu
1683
+ time zone, same as UTC).
1684
+ example: '2016-05-24T08:38:08.699-04:00'
1685
+ extensionList:
1686
+ title: ExtensionList
1634
1687
  type: object
1635
- required: *ref_0
1636
- properties: *ref_1
1688
+ description: >-
1689
+ Data model for the complex type ExtensionList. An
1690
+ optional list of extensions, specific to
1691
+ deployment.
1692
+ properties: *ref_10
1693
+ required: *ref_11
1694
+ currentState:
1695
+ type: string
1696
+ enum: &ref_43
1697
+ - ERROR_OCCURRED
1698
+ - COMPLETED
1637
1699
  individualTransferResults:
1638
1700
  type: array
1639
1701
  maxItems: 1000
1640
1702
  items:
1641
1703
  type: object
1642
- required: &ref_89
1643
- - transactionId
1644
- - to
1645
- - amountType
1646
- - currency
1647
- - amount
1648
- properties: &ref_90
1704
+ required: &ref_90
1705
+ - transferId
1706
+ properties: &ref_91
1649
1707
  transferId:
1650
1708
  title: CorrelationId
1651
1709
  type: string
@@ -1663,110 +1721,24 @@ paths:
1663
1721
  always 36 characters long, 32 hexadecimal
1664
1722
  symbols and 4 dashes (‘-‘).
1665
1723
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1666
- to:
1667
- type: object
1668
- required: *ref_0
1669
- properties: *ref_1
1670
- amountType:
1671
- title: AmountType
1672
- type: string
1673
- enum: *ref_3
1674
- description: >-
1675
- Below are the allowed values for the
1676
- enumeration AmountType.
1677
-
1678
- - SEND - Amount the Payer would like to
1679
- send, that is, the amount that should be
1680
- withdrawn from the Payer account including
1681
- any fees.
1682
-
1683
- - RECEIVE - Amount the Payer would like the
1684
- Payee to receive, that is, the amount that
1685
- should be sent to the receiver exclusive of
1686
- any fees.
1687
- example: RECEIVE
1688
- currency:
1689
- title: Currency
1724
+ fulfilment:
1690
1725
  description: >-
1691
- The currency codes defined in [ISO
1692
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
1693
- as three-letter alphabetic codes are used as
1694
- the standard naming representation for
1695
- currencies.
1696
- type: string
1697
- minLength: 3
1698
- maxLength: 3
1699
- enum: *ref_4
1700
- amount:
1701
- title: Amount
1726
+ Fulfilment that must be attached to the
1727
+ transfer by the Payee.
1728
+ title: IlpFulfilment
1702
1729
  type: string
1703
- pattern: >-
1704
- ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1705
- description: >-
1706
- The API data type Amount is a JSON String in
1707
- a canonical format that is restricted by a
1708
- regular expression for interoperability
1709
- reasons. This pattern does not allow any
1710
- trailing zeroes at all, but allows an amount
1711
- without a minor currency unit. It also only
1712
- allows four digits in the minor currency
1713
- unit; a negative value is not allowed. Using
1714
- more than 18 digits in the major currency
1715
- unit is not allowed.
1716
- example: '123.45'
1717
- transactionType:
1718
- title: transferTransactionType
1719
- type: string
1720
- enum: *ref_5
1721
- description: Type of transaction.
1722
- note:
1723
- title: Note
1724
- type: string
1725
- minLength: 1
1726
- maxLength: 128
1727
- description: Memo assigned to transaction.
1728
- example: Note sent to Payee.
1729
- quoteId:
1730
- title: CorrelationId
1731
- type: string
1732
- pattern: >-
1733
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1734
- description: >-
1735
- Identifier that correlates all messages of
1736
- the same sequence. The API data type UUID
1737
- (Universally Unique Identifier) is a JSON
1738
- String in canonical format, conforming to
1739
- [RFC
1740
- 4122](https://tools.ietf.org/html/rfc4122),
1741
- that is restricted by a regular expression
1742
- for interoperability reasons. A UUID is
1743
- always 36 characters long, 32 hexadecimal
1744
- symbols and 4 dashes (‘-‘).
1745
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1746
- quoteResponse:
1747
- title: QuotesIDPutResponse
1748
- type: object
1730
+ pattern: ^[A-Za-z0-9-_]{43}$
1731
+ maxLength: 48
1732
+ example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
1733
+ extensionList:
1749
1734
  description: >-
1750
- The object sent in the PUT /quotes/{ID}
1751
- callback.
1752
- properties: *ref_27
1753
- required: *ref_28
1754
- quoteResponseSource:
1755
- type: string
1756
- description: >
1757
- FSPID of the entity that supplied the quote
1758
- response. This may not be the same as the
1759
- FSPID of the entity which owns the end user
1760
- account in the case of a FOREX transfer.
1761
- i.e. it may be a FOREX gateway.
1762
- fulfil:
1763
- title: TransfersIDPutResponse
1735
+ Data model for the complex type
1736
+ ExtensionList. An optional list of
1737
+ extensions, specific to deployment.
1738
+ title: ExtensionList
1764
1739
  type: object
1765
- description: >-
1766
- The object sent in the PUT /transfers/{ID}
1767
- callback.
1768
- properties: *ref_20
1769
- required: *ref_21
1740
+ properties: *ref_10
1741
+ required: *ref_11
1770
1742
  lastError:
1771
1743
  type: object
1772
1744
  description: >-
@@ -1779,7 +1751,7 @@ paths:
1779
1751
  transfer response.
1780
1752
  '500':
1781
1753
  description: Internal Server Error
1782
- content: &ref_44
1754
+ content: &ref_42
1783
1755
  application/json:
1784
1756
  schema:
1785
1757
  type: object
@@ -1800,7 +1772,7 @@ paths:
1800
1772
  - name: bulkTransactionId
1801
1773
  in: path
1802
1774
  required: true
1803
- schema: &ref_158
1775
+ schema: &ref_159
1804
1776
  title: CorrelationId
1805
1777
  type: string
1806
1778
  pattern: >-
@@ -1827,10 +1799,10 @@ paths:
1827
1799
  The object sent back as confirmation of payee parties when
1828
1800
  autoAcceptParty is false.
1829
1801
  type: object
1830
- required: &ref_35
1802
+ required: &ref_34
1831
1803
  - bulkHomeTransactionID
1832
1804
  - individualTransfers
1833
- properties: &ref_36
1805
+ properties: &ref_35
1834
1806
  bulkHomeTransactionID:
1835
1807
  type: string
1836
1808
  description: >-
@@ -1850,23 +1822,13 @@ paths:
1850
1822
  description: >-
1851
1823
  Data model for the 'individualTransfer' while
1852
1824
  accepting party or quote.
1853
- properties: &ref_31
1825
+ properties: &ref_30
1854
1826
  homeTransactionId:
1855
- title: CorrelationId
1856
1827
  type: string
1857
- pattern: >-
1858
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1859
1828
  description: >-
1860
- Identifier that correlates all messages of the
1861
- same sequence. The API data type UUID
1862
- (Universally Unique Identifier) is a JSON
1863
- String in canonical format, conforming to [RFC
1864
- 4122](https://tools.ietf.org/html/rfc4122),
1865
- that is restricted by a regular expression for
1866
- interoperability reasons. A UUID is always 36
1867
- characters long, 32 hexadecimal symbols and 4
1868
- dashes (‘-‘).
1869
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
1829
+ Transaction ID from the DFSP backend, used to
1830
+ reconcile transactions between the Switch and
1831
+ DFSP backend systems.
1870
1832
  transactionId:
1871
1833
  title: CorrelationId
1872
1834
  type: string
@@ -1883,20 +1845,20 @@ paths:
1883
1845
  characters long, 32 hexadecimal symbols and 4
1884
1846
  dashes (‘-‘).
1885
1847
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1886
- required: &ref_32
1848
+ required: &ref_31
1887
1849
  - homeTransactionId
1888
1850
  - transactionId
1889
1851
  - type: object
1890
- required: *ref_29
1891
- properties: *ref_30
1852
+ required: *ref_28
1853
+ properties: *ref_29
1892
1854
  - description: >-
1893
1855
  The object sent back as confirmation of quotes when
1894
1856
  autoAcceptQuotes is false.
1895
1857
  type: object
1896
- required: &ref_38
1858
+ required: &ref_37
1897
1859
  - bulkHomeTransactionID
1898
1860
  - individualTransfers
1899
- properties: &ref_39
1861
+ properties: &ref_38
1900
1862
  bulkHomeTransactionID:
1901
1863
  type: string
1902
1864
  description: >-
@@ -1914,22 +1876,22 @@ paths:
1914
1876
  description: >-
1915
1877
  Data model for the 'individualTransfer' while
1916
1878
  accepting party or quote.
1917
- properties: *ref_31
1918
- required: *ref_32
1879
+ properties: *ref_30
1880
+ required: *ref_31
1919
1881
  - type: object
1920
- required: *ref_33
1921
- properties: *ref_34
1882
+ required: *ref_32
1883
+ properties: *ref_33
1922
1884
  required: true
1923
1885
  responses:
1924
1886
  '202':
1925
1887
  description: Bulk transaction information successfully amended
1926
1888
  '400':
1927
1889
  description: Malformed or missing required body, headers or parameters
1928
- content: &ref_143
1890
+ content: &ref_144
1929
1891
  application/json:
1930
1892
  schema:
1931
1893
  oneOf:
1932
- - allOf: &ref_93
1894
+ - allOf: &ref_94
1933
1895
  - type: object
1934
1896
  properties: *ref_22
1935
1897
  - type: object
@@ -1942,14 +1904,14 @@ paths:
1942
1904
  The object sent back as confirmation of payee
1943
1905
  parties when autoAcceptParty is false.
1944
1906
  type: object
1945
- required: *ref_35
1946
- properties: *ref_36
1907
+ required: *ref_34
1908
+ properties: *ref_35
1947
1909
  - type: object
1948
1910
  description: >-
1949
1911
  This object represents a Mojaloop API error
1950
1912
  received at any time during the party
1951
1913
  discovery process
1952
- properties: &ref_92
1914
+ properties: &ref_93
1953
1915
  httpStatusCode:
1954
1916
  type: integer
1955
1917
  description: >-
@@ -1964,8 +1926,8 @@ paths:
1964
1926
  API exchange, this property will contain
1965
1927
  the underlying Mojaloop API error object.
1966
1928
  type: object
1967
- properties: *ref_37
1968
- - allOf: &ref_94
1929
+ properties: *ref_36
1930
+ - allOf: &ref_95
1969
1931
  - type: object
1970
1932
  properties: *ref_22
1971
1933
  - type: object
@@ -1978,13 +1940,13 @@ paths:
1978
1940
  The object sent back as confirmation of quotes
1979
1941
  when autoAcceptQuotes is false.
1980
1942
  type: object
1981
- required: *ref_38
1982
- properties: *ref_39
1943
+ required: *ref_37
1944
+ properties: *ref_38
1983
1945
  - type: object
1984
1946
  description: >-
1985
1947
  This object represents a Mojaloop API error
1986
1948
  received at any time during the quote process
1987
- properties: &ref_45
1949
+ properties: &ref_46
1988
1950
  httpStatusCode:
1989
1951
  type: integer
1990
1952
  description: >-
@@ -1999,7 +1961,7 @@ paths:
1999
1961
  API exchange, this property will contain
2000
1962
  the underlying Mojaloop API error object.
2001
1963
  type: object
2002
- properties: *ref_37
1964
+ properties: *ref_36
2003
1965
  '500':
2004
1966
  description: An error occurred processing the bulk transaction
2005
1967
  content:
@@ -2021,11 +1983,11 @@ paths:
2021
1983
  application/json:
2022
1984
  schema:
2023
1985
  type: object
2024
- required: &ref_100
1986
+ required: &ref_98
2025
1987
  - homeTransactionId
2026
1988
  - from
2027
1989
  - individualTransfers
2028
- properties: &ref_101
1990
+ properties: &ref_99
2029
1991
  homeTransactionId:
2030
1992
  type: string
2031
1993
  description: >-
@@ -2058,7 +2020,7 @@ paths:
2058
2020
  title: IndividualTransfer
2059
2021
  type: object
2060
2022
  description: Data model for the complex type 'individualTransfer'.
2061
- properties: &ref_98
2023
+ properties: &ref_96
2062
2024
  transferId:
2063
2025
  title: CorrelationId
2064
2026
  type: string
@@ -2121,142 +2083,10 @@ paths:
2121
2083
  digits in the major currency unit is not allowed.
2122
2084
  example: '123.45'
2123
2085
  transactionType:
2124
- title: TransactionType
2125
- type: object
2126
- description: Data model for the complex type TransactionType.
2127
- properties: &ref_51
2128
- scenario:
2129
- title: TransactionScenario
2130
- type: string
2131
- enum: &ref_95
2132
- - DEPOSIT
2133
- - WITHDRAWAL
2134
- - TRANSFER
2135
- - PAYMENT
2136
- - REFUND
2137
- description: >-
2138
- Below are the allowed values for the enumeration.
2139
-
2140
- - DEPOSIT - Used for performing a Cash-In
2141
- (deposit) transaction. In a normal scenario,
2142
- electronic funds are transferred from a Business
2143
- account to a Consumer account, and physical cash
2144
- is given from the Consumer to the Business User.
2145
-
2146
- - WITHDRAWAL - Used for performing a Cash-Out
2147
- (withdrawal) transaction. In a normal scenario,
2148
- electronic funds are transferred from a Consumer’s
2149
- account to a Business account, and physical cash
2150
- is given from the Business User to the Consumer.
2151
-
2152
- - TRANSFER - Used for performing a P2P (Peer to
2153
- Peer, or Consumer to Consumer) transaction.
2154
-
2155
- - PAYMENT - Usually used for performing a
2156
- transaction from a Consumer to a Merchant or
2157
- Organization, but could also be for a B2B
2158
- (Business to Business) payment. The transaction
2159
- could be online for a purchase in an Internet
2160
- store, in a physical store where both the Consumer
2161
- and Business User are present, a bill payment, a
2162
- donation, and so on.
2163
-
2164
- - REFUND - Used for performing a refund of
2165
- transaction.
2166
- example: DEPOSIT
2167
- subScenario:
2168
- title: TransactionSubScenario
2169
- type: string
2170
- pattern: ^[A-Z_]{1,32}$
2171
- description: >-
2172
- Possible sub-scenario, defined locally within the
2173
- scheme (UndefinedEnum Type).
2174
- example: LOCALLY_DEFINED_SUBSCENARIO
2175
- initiator:
2176
- title: TransactionInitiator
2177
- type: string
2178
- enum: &ref_53
2179
- - PAYER
2180
- - PAYEE
2181
- description: >-
2182
- Below are the allowed values for the enumeration.
2183
-
2184
- - PAYER - Sender of funds is initiating the
2185
- transaction. The account to send from is either
2186
- owned by the Payer or is connected to the Payer in
2187
- some way.
2188
-
2189
- - PAYEE - Recipient of the funds is initiating the
2190
- transaction by sending a transaction request. The
2191
- Payer must approve the transaction, either
2192
- automatically by a pre-generated OTP or by
2193
- pre-approval of the Payee, or by manually
2194
- approving in his or her own Device.
2195
- example: PAYEE
2196
- initiatorType:
2197
- title: TransactionInitiatorType
2198
- type: string
2199
- enum: *ref_40
2200
- description: >-
2201
- Below are the allowed values for the enumeration.
2202
-
2203
- - CONSUMER - Consumer is the initiator of the
2204
- transaction.
2205
-
2206
- - AGENT - Agent is the initiator of the
2207
- transaction.
2208
-
2209
- - BUSINESS - Business is the initiator of the
2210
- transaction.
2211
-
2212
- - DEVICE - Device is the initiator of the
2213
- transaction.
2214
- example: CONSUMER
2215
- refundInfo:
2216
- title: Refund
2217
- type: object
2218
- description: Data model for the complex type Refund.
2219
- properties: &ref_96
2220
- originalTransactionId:
2221
- title: CorrelationId
2222
- type: string
2223
- pattern: >-
2224
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2225
- description: >-
2226
- Identifier that correlates all messages of the
2227
- same sequence. The API data type UUID
2228
- (Universally Unique Identifier) is a JSON
2229
- String in canonical format, conforming to [RFC
2230
- 4122](https://tools.ietf.org/html/rfc4122),
2231
- that is restricted by a regular expression for
2232
- interoperability reasons. A UUID is always 36
2233
- characters long, 32 hexadecimal symbols and 4
2234
- dashes (‘-‘).
2235
- example: b51ec534-ee48-4575-b6a9-ead2955b8069
2236
- refundReason:
2237
- title: RefundReason
2238
- type: string
2239
- minLength: 1
2240
- maxLength: 128
2241
- description: Reason for the refund.
2242
- example: Free text indicating reason for the refund.
2243
- required: &ref_97
2244
- - originalTransactionId
2245
- balanceOfPayments:
2246
- title: BalanceOfPayments
2247
- type: string
2248
- pattern: ^[1-9]\d{2}$
2249
- description: >-
2250
- (BopCode) The API data type
2251
- [BopCode](https://www.imf.org/external/np/sta/bopcode/)
2252
- is a JSON String of 3 characters, consisting of
2253
- digits only. Negative numbers are not allowed. A
2254
- leading zero is not allowed.
2255
- example: '123'
2256
- required: &ref_52
2257
- - scenario
2258
- - initiator
2259
- - initiatorType
2086
+ title: transferTransactionType
2087
+ type: string
2088
+ enum: *ref_5
2089
+ description: Type of transaction.
2260
2090
  note:
2261
2091
  title: Note
2262
2092
  type: string
@@ -2272,7 +2102,7 @@ paths:
2272
2102
  optional list of extensions, specific to deployment.
2273
2103
  properties: *ref_10
2274
2104
  required: *ref_11
2275
- required: &ref_99
2105
+ required: &ref_97
2276
2106
  - transferId
2277
2107
  - to
2278
2108
  - amountType
@@ -2290,18 +2120,18 @@ paths:
2290
2120
  responses:
2291
2121
  '200':
2292
2122
  description: Bulk transfer completed successfully
2293
- content: &ref_144
2123
+ content: &ref_145
2294
2124
  application/json:
2295
2125
  schema:
2296
2126
  type: object
2297
- required: *ref_41
2298
- properties: *ref_42
2127
+ required: *ref_39
2128
+ properties: *ref_40
2299
2129
  '400':
2300
2130
  description: Malformed or missing required body, headers or parameters
2301
- content: *ref_43
2131
+ content: *ref_41
2302
2132
  '500':
2303
2133
  description: Internal Server Error
2304
- content: *ref_44
2134
+ content: *ref_42
2305
2135
  /bulkTransfers/{bulkTransferId}:
2306
2136
  get:
2307
2137
  summary: Retrieves information for a specific bulk transfer
@@ -2316,7 +2146,7 @@ paths:
2316
2146
  - name: bulkTransferId
2317
2147
  in: path
2318
2148
  required: true
2319
- schema: &ref_159
2149
+ schema: &ref_160
2320
2150
  title: CorrelationId
2321
2151
  type: string
2322
2152
  pattern: >-
@@ -2340,11 +2170,11 @@ paths:
2340
2170
  application/json:
2341
2171
  schema:
2342
2172
  type: object
2343
- required: &ref_104
2173
+ required: &ref_101
2344
2174
  - bulkTransferId
2345
2175
  - currentState
2346
2176
  - fulfils
2347
- properties: &ref_105
2177
+ properties: &ref_102
2348
2178
  bulkTransferId:
2349
2179
  title: CorrelationId
2350
2180
  type: string
@@ -2362,9 +2192,7 @@ paths:
2362
2192
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
2363
2193
  currentState:
2364
2194
  type: string
2365
- enum: &ref_102
2366
- - ERROR_OCCURRED
2367
- - COMPLETED
2195
+ enum: *ref_43
2368
2196
  fulfils:
2369
2197
  type: array
2370
2198
  minItems: 1
@@ -2374,7 +2202,7 @@ paths:
2374
2202
  description: >-
2375
2203
  A Mojaloop API transfer fulfilment for individual
2376
2204
  transfers in a bulk transfer
2377
- properties: &ref_103
2205
+ properties: &ref_100
2378
2206
  fulfilment:
2379
2207
  description: >-
2380
2208
  Fulfilment that must be attached to the transfer by
@@ -2413,11 +2241,11 @@ paths:
2413
2241
  application/json:
2414
2242
  schema:
2415
2243
  type: object
2416
- required: &ref_106
2244
+ required: &ref_103
2417
2245
  - homeTransactionId
2418
2246
  - from
2419
2247
  - individualQuotes
2420
- properties: &ref_107
2248
+ properties: &ref_104
2421
2249
  homeTransactionId:
2422
2250
  type: string
2423
2251
  description: >-
@@ -2450,7 +2278,7 @@ paths:
2450
2278
  title: IndividualQuote
2451
2279
  type: object
2452
2280
  description: Data model for the complex type 'individualQuote'.
2453
- properties: &ref_49
2281
+ properties: &ref_50
2454
2282
  quoteId:
2455
2283
  title: CorrelationId
2456
2284
  type: string
@@ -2532,12 +2360,13 @@ paths:
2532
2360
  optional list of extensions, specific to deployment.
2533
2361
  properties: *ref_10
2534
2362
  required: *ref_11
2535
- required: &ref_50
2363
+ required: &ref_51
2536
2364
  - quoteId
2537
2365
  - to
2538
2366
  - amountType
2539
2367
  - currency
2540
2368
  - transactionType
2369
+ - amount
2541
2370
  extensions:
2542
2371
  title: ExtensionList
2543
2372
  type: object
@@ -2550,15 +2379,16 @@ paths:
2550
2379
  responses:
2551
2380
  '200':
2552
2381
  description: Bulk quote completed successfully
2553
- content: &ref_145
2382
+ content: &ref_146
2554
2383
  application/json:
2555
2384
  schema:
2556
2385
  type: object
2557
- required: &ref_46
2558
- - from
2386
+ required: &ref_47
2387
+ - bulkQuoteId
2559
2388
  - individualQuoteResults
2560
- properties: &ref_47
2561
- quoteId:
2389
+ - currentState
2390
+ properties: &ref_48
2391
+ bulkQuoteId:
2562
2392
  title: CorrelationId
2563
2393
  type: string
2564
2394
  pattern: >-
@@ -2578,16 +2408,40 @@ paths:
2578
2408
  description: >-
2579
2409
  Transaction ID from the DFSP backend, used to reconcile
2580
2410
  transactions between the Switch and DFSP backend systems.
2581
- from:
2411
+ expiration:
2412
+ title: DateTime
2413
+ type: string
2414
+ pattern: >-
2415
+ ^(?:[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)$
2416
+ description: >-
2417
+ The API data type DateTime is a JSON String in a lexical
2418
+ format that is restricted by a regular expression for
2419
+ interoperability reasons. The format is according to [ISO
2420
+ 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
2421
+ expressed in a combined date, time and time zone format. A
2422
+ more readable version of the format is
2423
+ yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
2424
+ "2016-05-24T08:38:08.699-04:00",
2425
+ "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time
2426
+ zone, same as UTC).
2427
+ example: '2016-05-24T08:38:08.699-04:00'
2428
+ extensionList:
2429
+ title: ExtensionList
2582
2430
  type: object
2583
- required: *ref_0
2584
- properties: *ref_1
2431
+ description: >-
2432
+ Data model for the complex type ExtensionList. An optional
2433
+ list of extensions, specific to deployment.
2434
+ properties: *ref_10
2435
+ required: *ref_11
2436
+ currentState:
2437
+ type: string
2438
+ enum: *ref_43
2585
2439
  individualQuoteResults:
2586
2440
  type: array
2587
2441
  maxItems: 1000
2588
2442
  items:
2589
2443
  type: object
2590
- properties: &ref_108
2444
+ properties: &ref_105
2591
2445
  quoteId:
2592
2446
  title: CorrelationId
2593
2447
  type: string
@@ -2604,79 +2458,86 @@ paths:
2604
2458
  characters long, 32 hexadecimal symbols and 4 dashes
2605
2459
  (‘-‘).
2606
2460
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
2607
- to:
2461
+ transferAmount:
2462
+ title: Money
2463
+ type: object
2464
+ description: Data model for the complex type Money.
2465
+ properties: *ref_6
2466
+ required: *ref_7
2467
+ payeeReceiveAmount:
2468
+ title: Money
2469
+ type: object
2470
+ description: Data model for the complex type Money.
2471
+ properties: *ref_6
2472
+ required: *ref_7
2473
+ payeeFspFee:
2474
+ title: Money
2475
+ type: object
2476
+ description: Data model for the complex type Money.
2477
+ properties: *ref_6
2478
+ required: *ref_7
2479
+ payeeFspCommission:
2480
+ title: Money
2481
+ type: object
2482
+ description: Data model for the complex type Money.
2483
+ properties: *ref_6
2484
+ required: *ref_7
2485
+ geoCode:
2486
+ title: GeoCode
2608
2487
  type: object
2609
- required: *ref_0
2610
- properties: *ref_1
2611
- amountType:
2612
- title: AmountType
2613
- type: string
2614
- enum: *ref_3
2615
- description: >-
2616
- Below are the allowed values for the enumeration
2617
- AmountType.
2618
-
2619
- - SEND - Amount the Payer would like to send, that
2620
- is, the amount that should be withdrawn from the
2621
- Payer account including any fees.
2622
-
2623
- - RECEIVE - Amount the Payer would like the Payee to
2624
- receive, that is, the amount that should be sent to
2625
- the receiver exclusive of any fees.
2626
- example: RECEIVE
2627
- currency:
2628
- title: Currency
2629
2488
  description: >-
2630
- The currency codes defined in [ISO
2631
- 4217](https://www.iso.org/iso-4217-currency-codes.html)
2632
- as three-letter alphabetic codes are used as the
2633
- standard naming representation for currencies.
2634
- type: string
2635
- minLength: 3
2636
- maxLength: 3
2637
- enum: *ref_4
2638
- amount:
2639
- title: Amount
2489
+ Data model for the complex type GeoCode. Indicates
2490
+ the geographic location from where the transaction
2491
+ was initiated.
2492
+ properties: *ref_44
2493
+ required: *ref_45
2494
+ ilpPacket:
2495
+ title: IlpPacket
2640
2496
  type: string
2641
- pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2497
+ pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
2498
+ minLength: 1
2499
+ maxLength: 32768
2642
2500
  description: >-
2643
- The API data type Amount is a JSON String in a
2644
- canonical format that is restricted by a regular
2645
- expression for interoperability reasons. This
2646
- pattern does not allow any trailing zeroes at all,
2647
- but allows an amount without a minor currency unit.
2648
- It also only allows four digits in the minor
2649
- currency unit; a negative value is not allowed.
2650
- Using more than 18 digits in the major currency unit
2651
- is not allowed.
2652
- example: '123.45'
2653
- transactionType:
2654
- title: transferTransactionType
2655
- type: string
2656
- enum: *ref_5
2657
- description: Type of transaction.
2658
- note:
2659
- title: Note
2501
+ Information for recipient (transport layer
2502
+ information).
2503
+ example: >-
2504
+ AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
2505
+ condition:
2506
+ title: IlpCondition
2660
2507
  type: string
2661
- minLength: 1
2662
- maxLength: 128
2663
- description: Memo assigned to transaction.
2664
- example: Note sent to Payee.
2508
+ pattern: ^[A-Za-z0-9-_]{43}$
2509
+ maxLength: 48
2510
+ description: >-
2511
+ Condition that must be attached to the transfer by
2512
+ the Payer.
2513
+ extensionList:
2514
+ description: >-
2515
+ Data model for the complex type ExtensionList. An
2516
+ optional list of extensions, specific to deployment.
2517
+ title: ExtensionList
2518
+ type: object
2519
+ properties: *ref_10
2520
+ required: *ref_11
2665
2521
  lastError:
2666
2522
  description: >-
2667
2523
  This object represents a Mojaloop API error received
2668
2524
  at any time during the quote process
2669
2525
  type: object
2670
- properties: *ref_45
2526
+ properties: *ref_46
2527
+ required: &ref_106
2528
+ - quoteId
2529
+ - transferAmount
2530
+ - ilpPacket
2531
+ - condition
2671
2532
  description: >-
2672
2533
  List of individualQuoteResults in a bulk transfer
2673
2534
  response.
2674
2535
  '400':
2675
2536
  description: Malformed or missing required body, headers or parameters
2676
- content: &ref_146
2537
+ content: &ref_147
2677
2538
  application/json:
2678
2539
  schema:
2679
- allOf: &ref_48
2540
+ allOf: &ref_49
2680
2541
  - type: object
2681
2542
  properties: *ref_22
2682
2543
  - type: object
@@ -2685,20 +2546,20 @@ paths:
2685
2546
  properties:
2686
2547
  bulkQuoteState:
2687
2548
  type: object
2688
- required: *ref_46
2689
- properties: *ref_47
2549
+ required: *ref_47
2550
+ properties: *ref_48
2690
2551
  '500':
2691
2552
  description: An error occurred processing the bulk quote
2692
- content: &ref_147
2553
+ content: &ref_148
2693
2554
  application/json:
2694
2555
  schema:
2695
- allOf: *ref_48
2556
+ allOf: *ref_49
2696
2557
  '504':
2697
2558
  description: Timeout occurred processing the bulk quote
2698
- content: &ref_148
2559
+ content: &ref_149
2699
2560
  application/json:
2700
2561
  schema:
2701
- allOf: *ref_48
2562
+ allOf: *ref_49
2702
2563
  /bulkQuotes/{bulkQuoteId}:
2703
2564
  get:
2704
2565
  summary: Retrieves information for a specific bulk quote
@@ -2713,7 +2574,7 @@ paths:
2713
2574
  - name: bulkQuoteId
2714
2575
  in: path
2715
2576
  required: true
2716
- schema: &ref_160
2577
+ schema: &ref_161
2717
2578
  title: CorrelationId
2718
2579
  type: string
2719
2580
  pattern: >-
@@ -2737,11 +2598,11 @@ paths:
2737
2598
  application/json:
2738
2599
  schema:
2739
2600
  type: object
2740
- required: &ref_110
2601
+ required: &ref_108
2741
2602
  - bulkQuoteId
2742
2603
  - currentState
2743
2604
  - individualQuotes
2744
- properties: &ref_111
2605
+ properties: &ref_109
2745
2606
  bulkQuoteId:
2746
2607
  title: CorrelationId
2747
2608
  type: string
@@ -2759,7 +2620,7 @@ paths:
2759
2620
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
2760
2621
  currentState:
2761
2622
  type: string
2762
- enum: &ref_109
2623
+ enum: &ref_107
2763
2624
  - ERROR_OCCURRED
2764
2625
  - COMPLETED
2765
2626
  individualQuotes:
@@ -2770,8 +2631,8 @@ paths:
2770
2631
  title: IndividualQuote
2771
2632
  type: object
2772
2633
  description: Data model for the complex type 'individualQuote'.
2773
- properties: *ref_49
2774
- required: *ref_50
2634
+ properties: *ref_50
2635
+ required: *ref_51
2775
2636
  '500':
2776
2637
  description: An error occurred processing the bulk quote
2777
2638
  content:
@@ -2798,7 +2659,7 @@ paths:
2798
2659
  application/json:
2799
2660
  schema:
2800
2661
  type: object
2801
- required: &ref_112
2662
+ required: &ref_113
2802
2663
  - homeTransactionId
2803
2664
  - from
2804
2665
  - to
@@ -2808,7 +2669,7 @@ paths:
2808
2669
  - scenario
2809
2670
  - initiator
2810
2671
  - initiatorType
2811
- properties: &ref_113
2672
+ properties: &ref_114
2812
2673
  homeTransactionId:
2813
2674
  type: string
2814
2675
  description: >-
@@ -2865,8 +2726,133 @@ paths:
2865
2726
  title: TransactionType
2866
2727
  type: object
2867
2728
  description: Data model for the complex type TransactionType.
2868
- properties: *ref_51
2869
- required: *ref_52
2729
+ properties: &ref_54
2730
+ scenario:
2731
+ title: TransactionScenario
2732
+ type: string
2733
+ enum: &ref_110
2734
+ - DEPOSIT
2735
+ - WITHDRAWAL
2736
+ - TRANSFER
2737
+ - PAYMENT
2738
+ - REFUND
2739
+ description: >-
2740
+ Below are the allowed values for the enumeration.
2741
+
2742
+ - DEPOSIT - Used for performing a Cash-In (deposit)
2743
+ transaction. In a normal scenario, electronic funds are
2744
+ transferred from a Business account to a Consumer
2745
+ account, and physical cash is given from the Consumer to
2746
+ the Business User.
2747
+
2748
+ - WITHDRAWAL - Used for performing a Cash-Out
2749
+ (withdrawal) transaction. In a normal scenario,
2750
+ electronic funds are transferred from a Consumer’s
2751
+ account to a Business account, and physical cash is
2752
+ given from the Business User to the Consumer.
2753
+
2754
+ - TRANSFER - Used for performing a P2P (Peer to Peer, or
2755
+ Consumer to Consumer) transaction.
2756
+
2757
+ - PAYMENT - Usually used for performing a transaction
2758
+ from a Consumer to a Merchant or Organization, but could
2759
+ also be for a B2B (Business to Business) payment. The
2760
+ transaction could be online for a purchase in an
2761
+ Internet store, in a physical store where both the
2762
+ Consumer and Business User are present, a bill payment,
2763
+ a donation, and so on.
2764
+
2765
+ - REFUND - Used for performing a refund of transaction.
2766
+ example: DEPOSIT
2767
+ subScenario:
2768
+ title: TransactionSubScenario
2769
+ type: string
2770
+ pattern: ^[A-Z_]{1,32}$
2771
+ description: >-
2772
+ Possible sub-scenario, defined locally within the scheme
2773
+ (UndefinedEnum Type).
2774
+ example: LOCALLY_DEFINED_SUBSCENARIO
2775
+ initiator:
2776
+ title: TransactionInitiator
2777
+ type: string
2778
+ enum: &ref_53
2779
+ - PAYER
2780
+ - PAYEE
2781
+ description: >-
2782
+ Below are the allowed values for the enumeration.
2783
+
2784
+ - PAYER - Sender of funds is initiating the transaction.
2785
+ The account to send from is either owned by the Payer or
2786
+ is connected to the Payer in some way.
2787
+
2788
+ - PAYEE - Recipient of the funds is initiating the
2789
+ transaction by sending a transaction request. The Payer
2790
+ must approve the transaction, either automatically by a
2791
+ pre-generated OTP or by pre-approval of the Payee, or by
2792
+ manually approving in his or her own Device.
2793
+ example: PAYEE
2794
+ initiatorType:
2795
+ title: TransactionInitiatorType
2796
+ type: string
2797
+ enum: *ref_52
2798
+ description: >-
2799
+ Below are the allowed values for the enumeration.
2800
+
2801
+ - CONSUMER - Consumer is the initiator of the
2802
+ transaction.
2803
+
2804
+ - AGENT - Agent is the initiator of the transaction.
2805
+
2806
+ - BUSINESS - Business is the initiator of the
2807
+ transaction.
2808
+
2809
+ - DEVICE - Device is the initiator of the transaction.
2810
+ example: CONSUMER
2811
+ refundInfo:
2812
+ title: Refund
2813
+ type: object
2814
+ description: Data model for the complex type Refund.
2815
+ properties: &ref_111
2816
+ originalTransactionId:
2817
+ title: CorrelationId
2818
+ type: string
2819
+ pattern: >-
2820
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2821
+ description: >-
2822
+ Identifier that correlates all messages of the same
2823
+ sequence. The API data type UUID (Universally Unique
2824
+ Identifier) is a JSON String in canonical format,
2825
+ conforming to [RFC
2826
+ 4122](https://tools.ietf.org/html/rfc4122), that is
2827
+ restricted by a regular expression for
2828
+ interoperability reasons. A UUID is always 36
2829
+ characters long, 32 hexadecimal symbols and 4 dashes
2830
+ (‘-‘).
2831
+ example: b51ec534-ee48-4575-b6a9-ead2955b8069
2832
+ refundReason:
2833
+ title: RefundReason
2834
+ type: string
2835
+ minLength: 1
2836
+ maxLength: 128
2837
+ description: Reason for the refund.
2838
+ example: Free text indicating reason for the refund.
2839
+ required: &ref_112
2840
+ - originalTransactionId
2841
+ balanceOfPayments:
2842
+ title: BalanceOfPayments
2843
+ type: string
2844
+ pattern: ^[1-9]\d{2}$
2845
+ description: >-
2846
+ (BopCode) The API data type
2847
+ [BopCode](https://www.imf.org/external/np/sta/bopcode/)
2848
+ is a JSON String of 3 characters, consisting of digits
2849
+ only. Negative numbers are not allowed. A leading zero
2850
+ is not allowed.
2851
+ example: '123'
2852
+ required: &ref_55
2853
+ - scenario
2854
+ - initiator
2855
+ - initiatorType
2870
2856
  initiator:
2871
2857
  title: TransactionInitiator
2872
2858
  type: string
@@ -2887,7 +2873,7 @@ paths:
2887
2873
  initiatorType:
2888
2874
  title: TransactionInitiatorType
2889
2875
  type: string
2890
- enum: *ref_40
2876
+ enum: *ref_52
2891
2877
  description: |-
2892
2878
  Below are the allowed values for the enumeration.
2893
2879
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -2899,11 +2885,11 @@ paths:
2899
2885
  responses:
2900
2886
  '200':
2901
2887
  description: Request to Pay completed successfully
2902
- content: &ref_149
2888
+ content: &ref_150
2903
2889
  application/json:
2904
2890
  schema:
2905
2891
  type: object
2906
- required: &ref_116
2892
+ required: &ref_117
2907
2893
  - transactionRequestId
2908
2894
  - from
2909
2895
  - to
@@ -2912,7 +2898,7 @@ paths:
2912
2898
  - amount
2913
2899
  - transactionType
2914
2900
  - requestToPayState
2915
- properties: &ref_117
2901
+ properties: &ref_118
2916
2902
  transactionRequestId:
2917
2903
  title: CorrelationId
2918
2904
  type: string
@@ -2981,8 +2967,8 @@ paths:
2981
2967
  title: TransactionType
2982
2968
  type: object
2983
2969
  description: Data model for the complex type TransactionType.
2984
- properties: *ref_51
2985
- required: *ref_52
2970
+ properties: *ref_54
2971
+ required: *ref_55
2986
2972
  initiator:
2987
2973
  title: TransactionInitiator
2988
2974
  type: string
@@ -3003,7 +2989,7 @@ paths:
3003
2989
  initiatorType:
3004
2990
  title: TransactionInitiatorType
3005
2991
  type: string
3006
- enum: *ref_40
2992
+ enum: *ref_52
3007
2993
  description: |-
3008
2994
  Below are the allowed values for the enumeration.
3009
2995
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -3014,7 +3000,7 @@ paths:
3014
3000
  authenticationType:
3015
3001
  title: AuthenticationType
3016
3002
  type: string
3017
- enum: &ref_114
3003
+ enum: &ref_115
3018
3004
  - OTP
3019
3005
  - QRCODE
3020
3006
  - U2F
@@ -3032,7 +3018,7 @@ paths:
3032
3018
  requestToPayState:
3033
3019
  title: TransactionRequestState
3034
3020
  type: string
3035
- enum: &ref_115
3021
+ enum: &ref_116
3036
3022
  - RECEIVED
3037
3023
  - PENDING
3038
3024
  - ACCEPTED
@@ -3098,7 +3084,7 @@ paths:
3098
3084
  application/json:
3099
3085
  schema:
3100
3086
  type: object
3101
- required: &ref_118
3087
+ required: &ref_119
3102
3088
  - requestToPayTransactionId
3103
3089
  - from
3104
3090
  - to
@@ -3108,7 +3094,7 @@ paths:
3108
3094
  - scenario
3109
3095
  - initiator
3110
3096
  - initiatorType
3111
- properties: &ref_119
3097
+ properties: &ref_120
3112
3098
  requestToPayTransactionId:
3113
3099
  type: string
3114
3100
  description: >-
@@ -3165,8 +3151,8 @@ paths:
3165
3151
  title: TransactionType
3166
3152
  type: object
3167
3153
  description: Data model for the complex type TransactionType.
3168
- properties: *ref_51
3169
- required: *ref_52
3154
+ properties: *ref_54
3155
+ required: *ref_55
3170
3156
  initiator:
3171
3157
  title: TransactionInitiator
3172
3158
  type: string
@@ -3187,7 +3173,7 @@ paths:
3187
3173
  initiatorType:
3188
3174
  title: TransactionInitiatorType
3189
3175
  type: string
3190
- enum: *ref_40
3176
+ enum: *ref_52
3191
3177
  description: |-
3192
3178
  Below are the allowed values for the enumeration.
3193
3179
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -3206,11 +3192,11 @@ paths:
3206
3192
  responses:
3207
3193
  '200':
3208
3194
  description: Transfer completed successfully
3209
- content: &ref_150
3195
+ content: &ref_151
3210
3196
  application/json:
3211
3197
  schema:
3212
3198
  type: object
3213
- required: &ref_120
3199
+ required: &ref_121
3214
3200
  - requestToPayTransactionId
3215
3201
  - from
3216
3202
  - to
@@ -3218,7 +3204,7 @@ paths:
3218
3204
  - currency
3219
3205
  - amount
3220
3206
  - transactionType
3221
- properties: &ref_121
3207
+ properties: &ref_122
3222
3208
  transferId:
3223
3209
  title: CorrelationId
3224
3210
  type: string
@@ -3322,8 +3308,8 @@ paths:
3322
3308
  title: QuotesIDPutResponse
3323
3309
  type: object
3324
3310
  description: The object sent in the PUT /quotes/{ID} callback.
3325
- properties: *ref_27
3326
- required: *ref_28
3311
+ properties: *ref_56
3312
+ required: *ref_57
3327
3313
  quoteResponseSource:
3328
3314
  type: string
3329
3315
  description: >
@@ -3345,7 +3331,7 @@ paths:
3345
3331
  properties: *ref_26
3346
3332
  '400':
3347
3333
  description: Malformed or missing required body, headers or parameters
3348
- content: &ref_151
3334
+ content: &ref_152
3349
3335
  application/json:
3350
3336
  schema:
3351
3337
  allOf: *ref_14
@@ -3380,12 +3366,12 @@ paths:
3380
3366
  schema:
3381
3367
  oneOf:
3382
3368
  - type: object
3383
- required: *ref_33
3384
- properties: *ref_34
3369
+ required: *ref_32
3370
+ properties: *ref_33
3385
3371
  - type: object
3386
- required: &ref_122
3372
+ required: &ref_123
3387
3373
  - acceptOTP
3388
- properties: &ref_123
3374
+ properties: &ref_124
3389
3375
  acceptOTP:
3390
3376
  type: boolean
3391
3377
  enum:
@@ -3395,7 +3381,7 @@ paths:
3395
3381
  - name: requestToPayTransactionId
3396
3382
  in: path
3397
3383
  required: true
3398
- schema: &ref_161
3384
+ schema: &ref_162
3399
3385
  title: CorrelationId
3400
3386
  type: string
3401
3387
  pattern: >-
@@ -3440,7 +3426,7 @@ paths:
3440
3426
  application/json:
3441
3427
  schema:
3442
3428
  type: array
3443
- items: &ref_54
3429
+ items: &ref_58
3444
3430
  type: object
3445
3431
  required:
3446
3432
  - idType
@@ -3535,13 +3521,13 @@ paths:
3535
3521
  responses:
3536
3522
  '200':
3537
3523
  description: Accounts creation completed
3538
- content: &ref_152
3524
+ content: &ref_153
3539
3525
  application/json:
3540
3526
  schema:
3541
3527
  type: object
3542
- required: &ref_55
3528
+ required: &ref_59
3543
3529
  - accounts
3544
- properties: &ref_56
3530
+ properties: &ref_60
3545
3531
  modelId:
3546
3532
  title: CorrelationId
3547
3533
  type: string
@@ -3559,10 +3545,10 @@ paths:
3559
3545
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3560
3546
  accounts:
3561
3547
  type: array
3562
- items: *ref_54
3548
+ items: *ref_58
3563
3549
  response:
3564
3550
  type: array
3565
- items: &ref_124
3551
+ items: &ref_125
3566
3552
  type: object
3567
3553
  required:
3568
3554
  - idType
@@ -3651,7 +3637,7 @@ paths:
3651
3637
  properties: *ref_22
3652
3638
  currentState:
3653
3639
  type: string
3654
- enum: &ref_125
3640
+ enum: &ref_126
3655
3641
  - ERROR_OCCURRED
3656
3642
  - COMPLETED
3657
3643
  lastError:
@@ -3671,10 +3657,10 @@ paths:
3671
3657
  type: object
3672
3658
  '400':
3673
3659
  description: An error occurred creating accounts
3674
- content: &ref_57
3660
+ content: &ref_61
3675
3661
  application/json:
3676
3662
  schema:
3677
- allOf: &ref_58
3663
+ allOf: &ref_62
3678
3664
  - type: object
3679
3665
  properties: *ref_22
3680
3666
  - type: object
@@ -3683,23 +3669,23 @@ paths:
3683
3669
  properties:
3684
3670
  executionState:
3685
3671
  type: object
3686
- required: *ref_55
3687
- properties: *ref_56
3672
+ required: *ref_59
3673
+ properties: *ref_60
3688
3674
  '500':
3689
3675
  description: An error occurred creating accounts
3690
- content: *ref_57
3676
+ content: *ref_61
3691
3677
  '504':
3692
3678
  description: Timeout occurred creating accounts
3693
- content: &ref_153
3679
+ content: &ref_154
3694
3680
  application/json:
3695
3681
  schema:
3696
- allOf: *ref_58
3682
+ allOf: *ref_62
3697
3683
  /parties/{Type}/{ID}:
3698
3684
  parameters:
3699
3685
  - name: Type
3700
3686
  in: path
3701
3687
  required: true
3702
- schema: &ref_61
3688
+ schema: &ref_65
3703
3689
  type: string
3704
3690
  description: >-
3705
3691
  The type of the party identifier. For example, `MSISDN`,
@@ -3707,7 +3693,7 @@ paths:
3707
3693
  - name: ID
3708
3694
  in: path
3709
3695
  required: true
3710
- schema: &ref_62
3696
+ schema: &ref_66
3711
3697
  type: string
3712
3698
  description: The identifier value.
3713
3699
  get:
@@ -3723,13 +3709,13 @@ paths:
3723
3709
  responses:
3724
3710
  '200':
3725
3711
  description: PartiesByIdSuccess
3726
- content: &ref_63
3712
+ content: &ref_67
3727
3713
  application/json:
3728
3714
  schema:
3729
3715
  title: partiesByIdResponse
3730
3716
  type: object
3731
3717
  description: GET /parties/{Type}/{ID} response object
3732
- properties: &ref_126
3718
+ properties: &ref_127
3733
3719
  party:
3734
3720
  properties:
3735
3721
  body:
@@ -3745,16 +3731,16 @@ paths:
3745
3731
  - headers
3746
3732
  currentState:
3747
3733
  type: string
3748
- enum: &ref_67
3734
+ enum: &ref_69
3749
3735
  - WAITING_FOR_ACTION
3750
3736
  - COMPLETED
3751
3737
  - ERROR_OCCURRED
3752
- required: &ref_127
3738
+ required: &ref_128
3753
3739
  - party
3754
3740
  - currentState
3755
3741
  '404':
3756
3742
  description: PartiesByIdError404
3757
- content: &ref_64
3743
+ content: &ref_68
3758
3744
  application/json:
3759
3745
  schema:
3760
3746
  type: object
@@ -3763,26 +3749,26 @@ paths:
3763
3749
  title: ErrorInformation
3764
3750
  type: object
3765
3751
  description: Data model for the complex type ErrorInformation.
3766
- properties: *ref_59
3767
- required: *ref_60
3752
+ properties: *ref_63
3753
+ required: *ref_64
3768
3754
  /parties/{Type}/{ID}/{SubId}:
3769
3755
  parameters:
3770
3756
  - name: Type
3771
3757
  in: path
3772
3758
  required: true
3773
- schema: *ref_61
3759
+ schema: *ref_65
3774
3760
  description: >-
3775
3761
  The type of the party identifier. For example, `MSISDN`,
3776
3762
  `PERSONAL_ID`.
3777
3763
  - name: ID
3778
3764
  in: path
3779
3765
  required: true
3780
- schema: *ref_62
3766
+ schema: *ref_66
3781
3767
  description: The identifier value.
3782
3768
  - name: SubId
3783
3769
  in: path
3784
3770
  required: true
3785
- schema: &ref_162
3771
+ schema: &ref_163
3786
3772
  type: string
3787
3773
  description: >-
3788
3774
  A sub-identifier of the party identifier, or a sub-type of the party
@@ -3800,10 +3786,10 @@ paths:
3800
3786
  responses:
3801
3787
  '200':
3802
3788
  description: PartiesByIdSuccess
3803
- content: *ref_63
3789
+ content: *ref_67
3804
3790
  '404':
3805
3791
  description: PartiesByIdError404
3806
- content: *ref_64
3792
+ content: *ref_68
3807
3793
  /quotes:
3808
3794
  post:
3809
3795
  summary: Quotes endpoint
@@ -3818,7 +3804,7 @@ paths:
3818
3804
  schema:
3819
3805
  title: simpleQuotesPostRequest
3820
3806
  type: object
3821
- properties: &ref_130
3807
+ properties: &ref_131
3822
3808
  fspId:
3823
3809
  title: FspId
3824
3810
  type: string
@@ -3829,7 +3815,7 @@ paths:
3829
3815
  title: QuotesPostRequest
3830
3816
  type: object
3831
3817
  description: The object sent in the POST /quotes request.
3832
- properties: &ref_128
3818
+ properties: &ref_129
3833
3819
  quoteId:
3834
3820
  title: CorrelationId
3835
3821
  type: string
@@ -3919,8 +3905,8 @@ paths:
3919
3905
  title: TransactionType
3920
3906
  type: object
3921
3907
  description: Data model for the complex type TransactionType.
3922
- properties: *ref_51
3923
- required: *ref_52
3908
+ properties: *ref_54
3909
+ required: *ref_55
3924
3910
  geoCode:
3925
3911
  title: GeoCode
3926
3912
  type: object
@@ -3928,8 +3914,8 @@ paths:
3928
3914
  Data model for the complex type GeoCode. Indicates the
3929
3915
  geographic location from where the transaction was
3930
3916
  initiated.
3931
- properties: *ref_65
3932
- required: *ref_66
3917
+ properties: *ref_44
3918
+ required: *ref_45
3933
3919
  note:
3934
3920
  title: Note
3935
3921
  type: string
@@ -3963,7 +3949,7 @@ paths:
3963
3949
  optional list of extensions, specific to deployment.
3964
3950
  properties: *ref_10
3965
3951
  required: *ref_11
3966
- required: &ref_129
3952
+ required: &ref_130
3967
3953
  - quoteId
3968
3954
  - transactionId
3969
3955
  - payee
@@ -3971,19 +3957,19 @@ paths:
3971
3957
  - amountType
3972
3958
  - amount
3973
3959
  - transactionType
3974
- required: &ref_131
3960
+ required: &ref_132
3975
3961
  - fspId
3976
3962
  - quotesPostRequest
3977
3963
  required: true
3978
3964
  responses:
3979
3965
  '200':
3980
3966
  description: sync response from POST /quotes
3981
- content: &ref_154
3967
+ content: &ref_155
3982
3968
  application/json:
3983
3969
  schema:
3984
3970
  title: QuotesPostResponse
3985
3971
  type: object
3986
- properties: &ref_132
3972
+ properties: &ref_133
3987
3973
  quotes:
3988
3974
  title: QuotesIDPutResponse
3989
3975
  type: object
@@ -4030,8 +4016,8 @@ paths:
4030
4016
  Data model for the complex type GeoCode. Indicates
4031
4017
  the geographic location from where the transaction
4032
4018
  was initiated.
4033
- properties: *ref_65
4034
- required: *ref_66
4019
+ properties: *ref_44
4020
+ required: *ref_45
4035
4021
  ilpPacket:
4036
4022
  title: IlpPacket
4037
4023
  type: string
@@ -4072,16 +4058,16 @@ paths:
4072
4058
  - headers
4073
4059
  currentState:
4074
4060
  type: string
4075
- enum: *ref_67
4076
- required: &ref_133
4061
+ enum: *ref_69
4062
+ required: &ref_134
4077
4063
  - quotes
4078
4064
  - currentState
4079
4065
  '500':
4080
4066
  description: An error occurred processing the quotes request
4081
- content: &ref_155
4067
+ content: &ref_156
4082
4068
  application/json:
4083
4069
  schema:
4084
- allOf: &ref_134
4070
+ allOf: &ref_135
4085
4071
  - type: object
4086
4072
  properties: *ref_22
4087
4073
  - type: object
@@ -4099,7 +4085,7 @@ paths:
4099
4085
  schema:
4100
4086
  title: SimpleTransfersPostRequest
4101
4087
  type: object
4102
- properties: &ref_137
4088
+ properties: &ref_138
4103
4089
  fspId:
4104
4090
  title: FspId
4105
4091
  type: string
@@ -4110,7 +4096,7 @@ paths:
4110
4096
  title: TransfersPostRequest
4111
4097
  type: object
4112
4098
  description: The object sent in the POST /transfers request.
4113
- properties: &ref_135
4099
+ properties: &ref_136
4114
4100
  transferId:
4115
4101
  title: CorrelationId
4116
4102
  type: string
@@ -4187,7 +4173,7 @@ paths:
4187
4173
  optional list of extensions, specific to deployment.
4188
4174
  properties: *ref_10
4189
4175
  required: *ref_11
4190
- required: &ref_136
4176
+ required: &ref_137
4191
4177
  - transferId
4192
4178
  - payeeFsp
4193
4179
  - payerFsp
@@ -4195,19 +4181,19 @@ paths:
4195
4181
  - ilpPacket
4196
4182
  - condition
4197
4183
  - expiration
4198
- required: &ref_138
4184
+ required: &ref_139
4199
4185
  - fspId
4200
4186
  - transfersPostRequest
4201
4187
  required: true
4202
4188
  responses:
4203
4189
  '200':
4204
4190
  description: sync response from POST /simpleTransfers
4205
- content: &ref_156
4191
+ content: &ref_157
4206
4192
  application/json:
4207
4193
  schema:
4208
4194
  title: SimpleTransfersPostResponse
4209
4195
  type: object
4210
- properties: &ref_139
4196
+ properties: &ref_140
4211
4197
  transfer:
4212
4198
  properties:
4213
4199
  body:
@@ -4223,16 +4209,16 @@ paths:
4223
4209
  - headers
4224
4210
  currentState:
4225
4211
  type: string
4226
- enum: *ref_67
4227
- required: &ref_140
4212
+ enum: *ref_69
4213
+ required: &ref_141
4228
4214
  - transfer
4229
4215
  - currentState
4230
4216
  '500':
4231
4217
  description: An error occurred processing the simple transfers request
4232
- content: &ref_157
4218
+ content: &ref_158
4233
4219
  application/json:
4234
4220
  schema:
4235
- allOf: &ref_141
4221
+ allOf: &ref_142
4236
4222
  - type: object
4237
4223
  properties: *ref_22
4238
4224
  - type: object
@@ -4241,7 +4227,7 @@ components:
4241
4227
  TransactionInitiatorType:
4242
4228
  title: TransactionInitiatorType
4243
4229
  type: string
4244
- enum: *ref_40
4230
+ enum: *ref_52
4245
4231
  description: |-
4246
4232
  Below are the allowed values for the enumeration.
4247
4233
  - CONSUMER - Consumer is the initiator of the transaction.
@@ -4461,8 +4447,8 @@ components:
4461
4447
  example: Note sent to Payee.
4462
4448
  transferRequest:
4463
4449
  type: object
4464
- required: *ref_68
4465
- properties: *ref_69
4450
+ required: *ref_70
4451
+ properties: *ref_71
4466
4452
  CorrelationId:
4467
4453
  title: CorrelationId
4468
4454
  type: string
@@ -4524,8 +4510,8 @@ components:
4524
4510
  description: >-
4525
4511
  Data model for the complex type GeoCode. Indicates the geographic
4526
4512
  location from where the transaction was initiated.
4527
- properties: *ref_65
4528
- required: *ref_66
4513
+ properties: *ref_44
4514
+ required: *ref_45
4529
4515
  IlpPacket:
4530
4516
  title: IlpPacket
4531
4517
  type: string
@@ -4553,8 +4539,8 @@ components:
4553
4539
  title: QuotesIDPutResponse
4554
4540
  type: object
4555
4541
  description: The object sent in the PUT /quotes/{ID} callback.
4556
- properties: *ref_27
4557
- required: *ref_28
4542
+ properties: *ref_56
4543
+ required: *ref_57
4558
4544
  IlpFulfilment:
4559
4545
  title: IlpFulfilment
4560
4546
  type: string
@@ -4565,7 +4551,7 @@ components:
4565
4551
  TransferState:
4566
4552
  title: TransferState
4567
4553
  type: string
4568
- enum: *ref_70
4554
+ enum: *ref_27
4569
4555
  description: >-
4570
4556
  Below are the allowed values for the enumeration.
4571
4557
 
@@ -4607,11 +4593,11 @@ components:
4607
4593
  title: ErrorInformation
4608
4594
  type: object
4609
4595
  description: Data model for the complex type ErrorInformation.
4610
- properties: *ref_59
4611
- required: *ref_60
4596
+ properties: *ref_63
4597
+ required: *ref_64
4612
4598
  mojaloopError:
4613
4599
  type: object
4614
- properties: *ref_37
4600
+ properties: *ref_36
4615
4601
  transferError:
4616
4602
  type: object
4617
4603
  description: >-
@@ -4629,40 +4615,40 @@ components:
4629
4615
  allOf: *ref_14
4630
4616
  transferStatusResponse:
4631
4617
  type: object
4632
- required: *ref_71
4633
- properties: *ref_72
4618
+ required: *ref_72
4619
+ properties: *ref_73
4634
4620
  transferContinuationAcceptParty:
4635
4621
  type: object
4636
- required: *ref_29
4637
- properties: *ref_30
4622
+ required: *ref_28
4623
+ properties: *ref_29
4638
4624
  transferContinuationAcceptQuote:
4639
4625
  type: object
4640
- required: *ref_33
4641
- properties: *ref_34
4626
+ required: *ref_32
4627
+ properties: *ref_33
4642
4628
  autoAcceptPartyOption:
4643
4629
  type: object
4644
- required: *ref_73
4645
- properties: *ref_74
4630
+ required: *ref_74
4631
+ properties: *ref_75
4646
4632
  bulkPerTransferFeeLimit:
4647
4633
  type: object
4648
- required: *ref_75
4649
- properties: *ref_76
4634
+ required: *ref_76
4635
+ properties: *ref_77
4650
4636
  autoAcceptQuote:
4651
4637
  type: object
4652
- required: *ref_77
4653
- properties: *ref_78
4638
+ required: *ref_78
4639
+ properties: *ref_79
4654
4640
  bulkTransactionOptions:
4655
4641
  type: object
4656
- required: *ref_79
4657
- properties: *ref_80
4642
+ required: *ref_80
4643
+ properties: *ref_81
4658
4644
  PartyIdInfo:
4659
4645
  title: PartyIdInfo
4660
4646
  type: object
4661
4647
  description: >-
4662
4648
  Data model for the complex type PartyIdInfo. An ExtensionList element
4663
4649
  has been added to this reqeust in version v1.1
4664
- properties: *ref_81
4665
- required: *ref_82
4650
+ properties: *ref_82
4651
+ required: *ref_83
4666
4652
  PartyName:
4667
4653
  title: PartyName
4668
4654
  type: string
@@ -4673,12 +4659,12 @@ components:
4673
4659
  title: PartyComplexName
4674
4660
  type: object
4675
4661
  description: Data model for the complex type PartyComplexName.
4676
- properties: *ref_83
4662
+ properties: *ref_84
4677
4663
  PartyPersonalInfo:
4678
4664
  title: PartyPersonalInfo
4679
4665
  type: object
4680
4666
  description: Data model for the complex type PartyPersonalInfo.
4681
- properties: *ref_84
4667
+ properties: *ref_85
4682
4668
  Party:
4683
4669
  title: Party
4684
4670
  type: object
@@ -4689,61 +4675,111 @@ components:
4689
4675
  title: IndividualTransaction
4690
4676
  type: object
4691
4677
  description: Data model for the complex type 'individualTransaction'.
4692
- properties: *ref_85
4693
- required: *ref_86
4678
+ properties: *ref_86
4679
+ required: *ref_87
4694
4680
  bulkTransactionRequest:
4695
4681
  type: object
4696
- required: *ref_87
4697
- properties: *ref_88
4682
+ required: *ref_88
4683
+ properties: *ref_89
4684
+ bulkTransferStatus:
4685
+ type: string
4686
+ enum: *ref_43
4698
4687
  individualTransferResult:
4699
4688
  type: object
4700
- required: *ref_89
4701
- properties: *ref_90
4689
+ required: *ref_90
4690
+ properties: *ref_91
4702
4691
  bulkTransferResponse:
4703
4692
  type: object
4704
- required: *ref_41
4705
- properties: *ref_42
4693
+ required: *ref_39
4694
+ properties: *ref_40
4706
4695
  bulkTransferErrorResponse:
4707
- allOf: *ref_91
4696
+ allOf: *ref_92
4708
4697
  individualTransactionAccept:
4709
4698
  type: object
4710
4699
  description: Data model for the 'individualTransfer' while accepting party or quote.
4711
- properties: *ref_31
4712
- required: *ref_32
4700
+ properties: *ref_30
4701
+ required: *ref_31
4713
4702
  bulkTransactionContinuationAcceptParty:
4714
4703
  description: >-
4715
4704
  The object sent back as confirmation of payee parties when
4716
4705
  autoAcceptParty is false.
4717
4706
  type: object
4718
- required: *ref_35
4719
- properties: *ref_36
4707
+ required: *ref_34
4708
+ properties: *ref_35
4720
4709
  bulkTransactionContinuationAcceptQuote:
4721
4710
  description: >-
4722
4711
  The object sent back as confirmation of quotes when autoAcceptQuotes is
4723
4712
  false.
4724
4713
  type: object
4725
- required: *ref_38
4726
- properties: *ref_39
4714
+ required: *ref_37
4715
+ properties: *ref_38
4727
4716
  partyError:
4728
4717
  type: object
4729
4718
  description: >-
4730
4719
  This object represents a Mojaloop API error received at any time during
4731
4720
  the party discovery process
4732
- properties: *ref_92
4721
+ properties: *ref_93
4733
4722
  bulkTransactionAcceptPartyErrorResponse:
4734
- allOf: *ref_93
4723
+ allOf: *ref_94
4735
4724
  quoteError:
4736
4725
  type: object
4737
4726
  description: >-
4738
4727
  This object represents a Mojaloop API error received at any time during
4739
4728
  the quote process
4740
- properties: *ref_45
4729
+ properties: *ref_46
4741
4730
  bulkTransactionAcceptQuoteErrorResponse:
4742
- allOf: *ref_94
4731
+ allOf: *ref_95
4732
+ individualTransfer:
4733
+ title: IndividualTransfer
4734
+ type: object
4735
+ description: Data model for the complex type 'individualTransfer'.
4736
+ properties: *ref_96
4737
+ required: *ref_97
4738
+ bulkTransferRequest:
4739
+ type: object
4740
+ required: *ref_98
4741
+ properties: *ref_99
4742
+ individualTransferFulfilment:
4743
+ type: object
4744
+ description: >-
4745
+ A Mojaloop API transfer fulfilment for individual transfers in a bulk
4746
+ transfer
4747
+ properties: *ref_100
4748
+ bulkTransferStatusResponse:
4749
+ type: object
4750
+ required: *ref_101
4751
+ properties: *ref_102
4752
+ individualQuote:
4753
+ title: IndividualQuote
4754
+ type: object
4755
+ description: Data model for the complex type 'individualQuote'.
4756
+ properties: *ref_50
4757
+ required: *ref_51
4758
+ bulkQuoteRequest:
4759
+ type: object
4760
+ required: *ref_103
4761
+ properties: *ref_104
4762
+ individualQuoteResult:
4763
+ type: object
4764
+ properties: *ref_105
4765
+ required: *ref_106
4766
+ bulkQuoteResponse:
4767
+ type: object
4768
+ required: *ref_47
4769
+ properties: *ref_48
4770
+ bulkQuoteErrorResponse:
4771
+ allOf: *ref_49
4772
+ bulkQuoteStatus:
4773
+ type: string
4774
+ enum: *ref_107
4775
+ bulkQuoteStatusResponse:
4776
+ type: object
4777
+ required: *ref_108
4778
+ properties: *ref_109
4743
4779
  TransactionScenario:
4744
4780
  title: TransactionScenario
4745
4781
  type: string
4746
- enum: *ref_95
4782
+ enum: *ref_110
4747
4783
  description: >-
4748
4784
  Below are the allowed values for the enumeration.
4749
4785
 
@@ -4803,8 +4839,8 @@ components:
4803
4839
  title: Refund
4804
4840
  type: object
4805
4841
  description: Data model for the complex type Refund.
4806
- properties: *ref_96
4807
- required: *ref_97
4842
+ properties: *ref_111
4843
+ required: *ref_112
4808
4844
  BalanceOfPayments:
4809
4845
  title: BalanceOfPayments
4810
4846
  type: string
@@ -4819,65 +4855,16 @@ components:
4819
4855
  title: TransactionType
4820
4856
  type: object
4821
4857
  description: Data model for the complex type TransactionType.
4822
- properties: *ref_51
4823
- required: *ref_52
4824
- individualTransfer:
4825
- title: IndividualTransfer
4826
- type: object
4827
- description: Data model for the complex type 'individualTransfer'.
4828
- properties: *ref_98
4829
- required: *ref_99
4830
- bulkTransferRequest:
4831
- type: object
4832
- required: *ref_100
4833
- properties: *ref_101
4834
- bulkTransferStatus:
4835
- type: string
4836
- enum: *ref_102
4837
- individualTransferFulfilment:
4838
- type: object
4839
- description: >-
4840
- A Mojaloop API transfer fulfilment for individual transfers in a bulk
4841
- transfer
4842
- properties: *ref_103
4843
- bulkTransferStatusResponse:
4844
- type: object
4845
- required: *ref_104
4846
- properties: *ref_105
4847
- individualQuote:
4848
- title: IndividualQuote
4849
- type: object
4850
- description: Data model for the complex type 'individualQuote'.
4851
- properties: *ref_49
4852
- required: *ref_50
4853
- bulkQuoteRequest:
4854
- type: object
4855
- required: *ref_106
4856
- properties: *ref_107
4857
- individualQuoteResult:
4858
- type: object
4859
- properties: *ref_108
4860
- bulkQuoteResponse:
4861
- type: object
4862
- required: *ref_46
4863
- properties: *ref_47
4864
- bulkQuoteErrorResponse:
4865
- allOf: *ref_48
4866
- bulkQuoteStatus:
4867
- type: string
4868
- enum: *ref_109
4869
- bulkQuoteStatusResponse:
4870
- type: object
4871
- required: *ref_110
4872
- properties: *ref_111
4858
+ properties: *ref_54
4859
+ required: *ref_55
4873
4860
  requestToPayRequest:
4874
4861
  type: object
4875
- required: *ref_112
4876
- properties: *ref_113
4862
+ required: *ref_113
4863
+ properties: *ref_114
4877
4864
  AuthenticationType:
4878
4865
  title: AuthenticationType
4879
4866
  type: string
4880
- enum: *ref_114
4867
+ enum: *ref_115
4881
4868
  description: |-
4882
4869
  Below are the allowed values for the enumeration AuthenticationType.
4883
4870
  - OTP - One-time password generated by the Payer FSP.
@@ -4887,7 +4874,7 @@ components:
4887
4874
  TransactionRequestState:
4888
4875
  title: TransactionRequestState
4889
4876
  type: string
4890
- enum: *ref_115
4877
+ enum: *ref_116
4891
4878
  description: |-
4892
4879
  Below are the allowed values for the enumeration.
4893
4880
  - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
@@ -4897,87 +4884,87 @@ components:
4897
4884
  example: RECEIVED
4898
4885
  requestToPayResponse:
4899
4886
  type: object
4900
- required: *ref_116
4901
- properties: *ref_117
4887
+ required: *ref_117
4888
+ properties: *ref_118
4902
4889
  requestToPayTransferRequest:
4903
4890
  type: object
4904
- required: *ref_118
4905
- properties: *ref_119
4891
+ required: *ref_119
4892
+ properties: *ref_120
4906
4893
  requestToPayTransferResponse:
4907
4894
  type: object
4908
- required: *ref_120
4909
- properties: *ref_121
4895
+ required: *ref_121
4896
+ properties: *ref_122
4910
4897
  transferContinuationAcceptOTP:
4911
4898
  type: object
4912
- required: *ref_122
4913
- properties: *ref_123
4899
+ required: *ref_123
4900
+ properties: *ref_124
4914
4901
  accountsRequest:
4915
4902
  type: array
4916
- items: *ref_54
4903
+ items: *ref_58
4917
4904
  accountCreationStatus:
4918
4905
  type: array
4919
- items: *ref_124
4906
+ items: *ref_125
4920
4907
  accountsCreationState:
4921
4908
  type: string
4922
- enum: *ref_125
4909
+ enum: *ref_126
4923
4910
  accountsResponse:
4924
4911
  type: object
4925
- required: *ref_55
4926
- properties: *ref_56
4912
+ required: *ref_59
4913
+ properties: *ref_60
4927
4914
  errorAccountsResponse:
4928
- allOf: *ref_58
4915
+ allOf: *ref_62
4929
4916
  async2SyncCurrentState:
4930
4917
  type: string
4931
- enum: *ref_67
4918
+ enum: *ref_69
4932
4919
  partiesByIdResponse:
4933
4920
  title: partiesByIdResponse
4934
4921
  type: object
4935
4922
  description: GET /parties/{Type}/{ID} response object
4936
- properties: *ref_126
4937
- required: *ref_127
4923
+ properties: *ref_127
4924
+ required: *ref_128
4938
4925
  QuotesPostRequest:
4939
4926
  title: QuotesPostRequest
4940
4927
  type: object
4941
4928
  description: The object sent in the POST /quotes request.
4942
- properties: *ref_128
4943
- required: *ref_129
4929
+ properties: *ref_129
4930
+ required: *ref_130
4944
4931
  simpleQuotesPostRequest:
4945
4932
  title: simpleQuotesPostRequest
4946
4933
  type: object
4947
- properties: *ref_130
4948
- required: *ref_131
4934
+ properties: *ref_131
4935
+ required: *ref_132
4949
4936
  quotesPostResponse:
4950
4937
  title: QuotesPostResponse
4951
4938
  type: object
4952
- properties: *ref_132
4953
- required: *ref_133
4939
+ properties: *ref_133
4940
+ required: *ref_134
4954
4941
  errorQuotesResponse:
4955
- allOf: *ref_134
4942
+ allOf: *ref_135
4956
4943
  TransfersPostRequest:
4957
4944
  title: TransfersPostRequest
4958
4945
  type: object
4959
4946
  description: The object sent in the POST /transfers request.
4960
- properties: *ref_135
4961
- required: *ref_136
4947
+ properties: *ref_136
4948
+ required: *ref_137
4962
4949
  simpleTransfersPostRequest:
4963
4950
  title: SimpleTransfersPostRequest
4964
4951
  type: object
4965
- properties: *ref_137
4966
- required: *ref_138
4952
+ properties: *ref_138
4953
+ required: *ref_139
4967
4954
  simpleTransfersPostResponse:
4968
4955
  title: SimpleTransfersPostResponse
4969
4956
  type: object
4970
- properties: *ref_139
4971
- required: *ref_140
4957
+ properties: *ref_140
4958
+ required: *ref_141
4972
4959
  errorSimpleTransfersResponse:
4973
- allOf: *ref_141
4960
+ allOf: *ref_142
4974
4961
  responses:
4975
4962
  transferSuccess:
4976
4963
  description: Transfer completed successfully
4977
4964
  content: *ref_15
4978
4965
  transferBadRequest:
4979
4966
  description: Malformed or missing required body, headers or parameters
4980
- content: *ref_142
4967
+ content: *ref_143
4981
4968
  transferServerError:
4982
4969
  description: An error occurred processing the transfer
4983
4970
  content: *ref_16
@@ -4988,64 +4975,64 @@ components:
4988
4975
  description: Bulk transfer accepted successfully
4989
4976
  bulkTransferBadRequest:
4990
4977
  description: Malformed or missing required body, headers or parameters
4991
- content: *ref_43
4978
+ content: *ref_41
4992
4979
  errorResponse:
4993
4980
  description: Internal Server Error
4994
- content: *ref_44
4981
+ content: *ref_42
4995
4982
  bulkTransactionPutBadRequest:
4996
4983
  description: Malformed or missing required body, headers or parameters
4997
- content: *ref_143
4984
+ content: *ref_144
4998
4985
  bulkTransferSuccess:
4999
4986
  description: Bulk transfer completed successfully
5000
- content: *ref_144
4987
+ content: *ref_145
5001
4988
  bulkQuoteSuccess:
5002
4989
  description: Bulk quote completed successfully
5003
- content: *ref_145
4990
+ content: *ref_146
5004
4991
  bulkQuoteBadRequest:
5005
4992
  description: Malformed or missing required body, headers or parameters
5006
- content: *ref_146
4993
+ content: *ref_147
5007
4994
  bulkQuoteServerError:
5008
4995
  description: An error occurred processing the bulk quote
5009
- content: *ref_147
4996
+ content: *ref_148
5010
4997
  bulkQuoteTimeout:
5011
4998
  description: Timeout occurred processing the bulk quote
5012
- content: *ref_148
4999
+ content: *ref_149
5013
5000
  requestToPaySuccess:
5014
5001
  description: Request to Pay completed successfully
5015
- content: *ref_149
5002
+ content: *ref_150
5016
5003
  requestToPayTransferSuccess:
5017
5004
  description: Transfer completed successfully
5018
- content: *ref_150
5005
+ content: *ref_151
5019
5006
  requestToPayTransferBadRequest:
5020
5007
  description: Malformed or missing required body, headers or parameters
5021
- content: *ref_151
5008
+ content: *ref_152
5022
5009
  accountsCreationCompleted:
5023
5010
  description: Accounts creation completed
5024
- content: *ref_152
5011
+ content: *ref_153
5025
5012
  accountsCreationError:
5026
5013
  description: An error occurred creating accounts
5027
- content: *ref_57
5014
+ content: *ref_61
5028
5015
  accountsCreationTimeout:
5029
5016
  description: Timeout occurred creating accounts
5030
- content: *ref_153
5017
+ content: *ref_154
5031
5018
  partiesByIdSuccess:
5032
5019
  description: PartiesByIdSuccess
5033
- content: *ref_63
5020
+ content: *ref_67
5034
5021
  partiesByIdError404:
5035
5022
  description: PartiesByIdError404
5036
- content: *ref_64
5023
+ content: *ref_68
5037
5024
  quotesPostSuccess:
5038
5025
  description: sync response from POST /quotes
5039
- content: *ref_154
5026
+ content: *ref_155
5040
5027
  quotesServerError:
5041
5028
  description: An error occurred processing the quotes request
5042
- content: *ref_155
5029
+ content: *ref_156
5043
5030
  simpleTransfersPostSuccess:
5044
5031
  description: sync response from POST /simpleTransfers
5045
- content: *ref_156
5032
+ content: *ref_157
5046
5033
  simpleTransfersServerError:
5047
5034
  description: An error occurred processing the simple transfers request
5048
- content: *ref_157
5035
+ content: *ref_158
5049
5036
  parameters:
5050
5037
  transferId:
5051
5038
  name: transferId
@@ -5059,7 +5046,7 @@ components:
5059
5046
  name: bulkTransactionId
5060
5047
  in: path
5061
5048
  required: true
5062
- schema: *ref_158
5049
+ schema: *ref_159
5063
5050
  description: >-
5064
5051
  Identifier of the bulk transaction to continue as returned in the
5065
5052
  response to a `POST /bulkTransaction` request.
@@ -5067,7 +5054,7 @@ components:
5067
5054
  name: bulkTransferId
5068
5055
  in: path
5069
5056
  required: true
5070
- schema: *ref_159
5057
+ schema: *ref_160
5071
5058
  description: >-
5072
5059
  Identifier of the bulk transfer to continue as returned in the response
5073
5060
  to a `POST /bulkTransfers` request.
@@ -5075,7 +5062,7 @@ components:
5075
5062
  name: bulkQuoteId
5076
5063
  in: path
5077
5064
  required: true
5078
- schema: *ref_160
5065
+ schema: *ref_161
5079
5066
  description: >-
5080
5067
  Identifier of the bulk transfer to continue as returned in the response
5081
5068
  to a `POST /bulkTransfers` request.
@@ -5083,7 +5070,7 @@ components:
5083
5070
  name: requestToPayTransactionId
5084
5071
  in: path
5085
5072
  required: true
5086
- schema: *ref_161
5073
+ schema: *ref_162
5087
5074
  description: >-
5088
5075
  Identifier of the merchant request to pay transfer to continue as
5089
5076
  returned in the response to a `POST /requestToPayTransfer` request.
@@ -5091,19 +5078,19 @@ components:
5091
5078
  name: Type
5092
5079
  in: path
5093
5080
  required: true
5094
- schema: *ref_61
5081
+ schema: *ref_65
5095
5082
  description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
5096
5083
  ID:
5097
5084
  name: ID
5098
5085
  in: path
5099
5086
  required: true
5100
- schema: *ref_62
5087
+ schema: *ref_66
5101
5088
  description: The identifier value.
5102
5089
  SubId:
5103
5090
  name: SubId
5104
5091
  in: path
5105
5092
  required: true
5106
- schema: *ref_162
5093
+ schema: *ref_163
5107
5094
  description: >-
5108
5095
  A sub-identifier of the party identifier, or a sub-type of the party
5109
5096
  identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.