@mojaloop/api-snippets 17.0.2-snapshot.1 → 17.0.3-snapshot.0

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 +8 -0
  2. package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +1391 -2577
  3. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1967 -4347
  4. package/docs/thirdparty-openapi3-snippets.yaml +1943 -7084
  5. package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +1114 -635
  6. package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +314 -5142
  7. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.d.ts +895 -442
  8. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +5 -4
  9. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
  10. package/lib/sdk-scheme-adapter/v2_0_0/backend/types.d.ts +5 -4
  11. package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +18112 -18112
  12. package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +922 -26232
  13. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.d.ts +5425 -5425
  14. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +45 -45
  15. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
  16. package/lib/sdk-scheme-adapter/v2_0_0/outbound/types.d.ts +45 -45
  17. package/lib/thirdparty/openapi.d.ts +1269 -25214
  18. package/package.json +9 -9
  19. package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml +7 -49
  20. package/sdk-scheme-adapter/v2_0_0/components/schemas/bulkTransactionIndividualTransferResult.yaml +2 -7
  21. package/sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml +16 -16
package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json CHANGED
@@ -410,11 +410,11 @@
410
410
  "type": "string"
411
411
  },
412
412
  "subScenario": {
413
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
414
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
413
+ "title": "TransactionSubScenario",
414
+ "type": "string",
415
415
  "pattern": "^[A-Z_]{1,32}$",
416
- "title": "transactionSubScenario",
417
- "type": "string"
416
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
417
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
418
418
  },
419
419
  "to": {
420
420
  "properties": {
@@ -1658,11 +1658,11 @@
1658
1658
  "type": "string"
1659
1659
  },
1660
1660
  "subScenario": {
1661
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
1662
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
1661
+ "title": "TransactionSubScenario",
1662
+ "type": "string",
1663
1663
  "pattern": "^[A-Z_]{1,32}$",
1664
- "title": "transactionSubScenario",
1665
- "type": "string"
1664
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
1665
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
1666
1666
  },
1667
1667
  "to": {
1668
1668
  "properties": {
@@ -2555,11 +2555,11 @@
2555
2555
  "type": "string"
2556
2556
  },
2557
2557
  "subScenario": {
2558
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
2559
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
2558
+ "title": "TransactionSubScenario",
2559
+ "type": "string",
2560
2560
  "pattern": "^[A-Z_]{1,32}$",
2561
- "title": "transactionSubScenario",
2562
- "type": "string"
2561
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
2562
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
2563
2563
  },
2564
2564
  "to": {
2565
2565
  "properties": {
@@ -4720,11 +4720,11 @@
4720
4720
  "type": "string"
4721
4721
  },
4722
4722
  "subScenario": {
4723
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
4724
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
4723
+ "title": "TransactionSubScenario",
4724
+ "type": "string",
4725
4725
  "pattern": "^[A-Z_]{1,32}$",
4726
- "title": "transactionSubScenario",
4727
- "type": "string"
4726
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
4727
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
4728
4728
  },
4729
4729
  "to": {
4730
4730
  "properties": {
@@ -5266,12 +5266,10 @@
5266
5266
  "properties": {
5267
5267
  "completedTimestamp": {
5268
5268
  "description": "An ISO-8601 formatted timestamp.",
5269
- "example": "2020-05-19T08:38:08.699-04:00",
5270
5269
  "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$",
5271
5270
  "type": "string"
5272
5271
  },
5273
5272
  "extensionList": {
5274
- "description": "Optional extension, specific to deployment.",
5275
5273
  "items": {
5276
5274
  "properties": {
5277
5275
  "key": {
@@ -5293,7 +5291,6 @@
5293
5291
  },
5294
5292
  "transferState": {
5295
5293
  "description": "Below are the allowed values for the enumeration - RECEIVED DFSP has received the transfer. - RESERVED DFSP has reserved the transfer. - COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP has aborted the transfer due a rejection or failure to perform the transfer.\n",
5296
- "example": "COMMITTED",
5297
5294
  "enum": [
5298
5295
  "RECEIVED",
5299
5296
  "RESERVED",
@@ -5707,9 +5704,9 @@
5707
5704
  "type": "object"
5708
5705
  },
5709
5706
  "payee": {
5710
- "description": "Data model for the complex type Party.",
5711
5707
  "title": "Party",
5712
5708
  "type": "object",
5709
+ "description": "Data model for the complex type Party.",
5713
5710
  "properties": {
5714
5711
  "partyIdInfo": {
5715
5712
  "title": "PartyIdInfo",
@@ -5867,9 +5864,9 @@
5867
5864
  ]
5868
5865
  },
5869
5866
  "payer": {
5870
- "description": "Data model for the complex type Party.",
5871
5867
  "title": "Party",
5872
5868
  "type": "object",
5869
+ "description": "Data model for the complex type Party.",
5873
5870
  "properties": {
5874
5871
  "partyIdInfo": {
5875
5872
  "title": "PartyIdInfo",
@@ -6047,7 +6044,6 @@
6047
6044
  "type": "string"
6048
6045
  },
6049
6046
  "initiatorType": {
6050
- "description": "Specifies the type of the transaction initiator.",
6051
6047
  "enum": [
6052
6048
  "CONSUMER",
6053
6049
  "AGENT",
@@ -6063,11 +6059,11 @@
6063
6059
  "type": "string"
6064
6060
  },
6065
6061
  "subScenario": {
6066
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
6067
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
6062
+ "title": "TransactionSubScenario",
6063
+ "type": "string",
6068
6064
  "pattern": "^[A-Z_]{1,32}$",
6069
- "title": "transactionSubScenario",
6070
- "type": "string"
6065
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
6066
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
6071
6067
  }
6072
6068
  },
6073
6069
  "required": [
@@ -6159,12 +6155,10 @@
6159
6155
  "description": "A request for a quote for transfer from the DFSP backend.",
6160
6156
  "properties": {
6161
6157
  "amount": {
6162
- "description": "Depending on `amountType`. If SEND - The amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. The amount is updated by each participating entity in the transaction. If RECEIVE - The amount the Payee should receive, that is, the amount that should be sent to the receiver exclusive any fees. The amount is not updated by any of the participating entities.",
6163
6158
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
6164
6159
  "type": "string"
6165
6160
  },
6166
6161
  "amountType": {
6167
- "description": "SEND for send amount, RECEIVE for receive amount.",
6168
6162
  "enum": [
6169
6163
  "SEND",
6170
6164
  "RECEIVE"
@@ -6368,7 +6362,6 @@
6368
6362
  "type": "array"
6369
6363
  },
6370
6364
  "feesAmount": {
6371
- "description": "The fees in the transaction. The fees element should be empty if fees should be non-disclosed. The fees element should be non-empty if fees should be disclosed.",
6372
6365
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
6373
6366
  "type": "string"
6374
6367
  },
@@ -6544,7 +6537,6 @@
6544
6537
  "type": "string"
6545
6538
  },
6546
6539
  "from": {
6547
- "description": "Information about the Payer in the proposed financial transaction.",
6548
6540
  "properties": {
6549
6541
  "dateOfBirth": {
6550
6542
  "description": "Date of birth in the form YYYY-MM-DD.",
@@ -6655,7 +6647,6 @@
6655
6647
  "type": "object"
6656
6648
  },
6657
6649
  "initiator": {
6658
- "description": "Specifies if the initiator of the transfer is the Payer or Payee.",
6659
6650
  "enum": [
6660
6651
  "PAYER",
6661
6652
  "PAYEE"
@@ -6663,7 +6654,6 @@
6663
6654
  "type": "string"
6664
6655
  },
6665
6656
  "initiatorType": {
6666
- "description": "Specifies the type of the transaction initiator.",
6667
6657
  "enum": [
6668
6658
  "CONSUMER",
6669
6659
  "AGENT",
@@ -6684,14 +6674,13 @@
6684
6674
  "type": "string"
6685
6675
  },
6686
6676
  "subScenario": {
6687
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
6688
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
6677
+ "title": "TransactionSubScenario",
6678
+ "type": "string",
6689
6679
  "pattern": "^[A-Z_]{1,32}$",
6690
- "title": "transactionSubScenario",
6691
- "type": "string"
6680
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
6681
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
6692
6682
  },
6693
6683
  "to": {
6694
- "description": "Information about the Payee in the proposed financial transaction.",
6695
6684
  "properties": {
6696
6685
  "dateOfBirth": {
6697
6686
  "description": "Date of birth in the form YYYY-MM-DD.",
@@ -6787,7 +6776,6 @@
6787
6776
  "type": "string"
6788
6777
  },
6789
6778
  "transactionType": {
6790
- "description": "Type of transaction for which the quote is requested.",
6791
6779
  "enum": [
6792
6780
  "TRANSFER",
6793
6781
  "DEPOSIT",
@@ -6859,12 +6847,10 @@
6859
6847
  "type": "object"
6860
6848
  },
6861
6849
  "payeeFspCommissionAmount": {
6862
- "description": "Transaction commission from the Payee FSP.",
6863
6850
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
6864
6851
  "type": "string"
6865
6852
  },
6866
6853
  "payeeFspCommissionAmountCurrency": {
6867
- "description": "Currency of the `payeeFspCommissionAmount`.",
6868
6854
  "enum": [
6869
6855
  "AED",
6870
6856
  "AFN",
@@ -7036,12 +7022,10 @@
7036
7022
  "type": "string"
7037
7023
  },
7038
7024
  "payeeFspFeeAmount": {
7039
- "description": "Payee FSP’s part of the transaction fee.",
7040
7025
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
7041
7026
  "type": "string"
7042
7027
  },
7043
7028
  "payeeFspFeeAmountCurrency": {
7044
- "description": "The currency of the `payeeFspFeeAmount`.",
7045
7029
  "enum": [
7046
7030
  "AED",
7047
7031
  "AFN",
@@ -7213,12 +7197,10 @@
7213
7197
  "type": "string"
7214
7198
  },
7215
7199
  "payeeReceiveAmount": {
7216
- "description": "The amount that the Payee should receive in the end-to-end transaction. Optional as the Payee FSP might not want to disclose any optional Payee fees.",
7217
7200
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
7218
7201
  "type": "string"
7219
7202
  },
7220
7203
  "payeeReceiveAmountCurrency": {
7221
- "description": "The currency of the `payeeReceiveAmount`.",
7222
7204
  "enum": [
7223
7205
  "AED",
7224
7206
  "AFN",
@@ -7400,12 +7382,10 @@
7400
7382
  "type": "string"
7401
7383
  },
7402
7384
  "transferAmount": {
7403
- "description": "The amount of money that the Payer FSP should transfer to the Payee FSP.",
7404
7385
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
7405
7386
  "type": "string"
7406
7387
  },
7407
7388
  "transferAmountCurrency": {
7408
- "description": "The currency of the `transferAmount`.",
7409
7389
  "enum": [
7410
7390
  "AED",
7411
7391
  "AFN",
@@ -8020,11 +8000,11 @@
8020
8000
  "type": "string"
8021
8001
  },
8022
8002
  "subScenario": {
8023
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
8024
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
8003
+ "title": "TransactionSubScenario",
8004
+ "type": "string",
8025
8005
  "pattern": "^[A-Z_]{1,32}$",
8026
- "title": "transactionSubScenario",
8027
- "type": "string"
8006
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
8007
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
8028
8008
  }
8029
8009
  },
8030
8010
  "required": [
@@ -8103,7 +8083,6 @@
8103
8083
  "type": "string"
8104
8084
  },
8105
8085
  "initiatorType": {
8106
- "description": "Specifies the type of the transaction initiator.",
8107
8086
  "enum": [
8108
8087
  "CONSUMER",
8109
8088
  "AGENT",
@@ -8119,11 +8098,11 @@
8119
8098
  "type": "string"
8120
8099
  },
8121
8100
  "subScenario": {
8122
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
8123
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
8101
+ "title": "TransactionSubScenario",
8102
+ "type": "string",
8124
8103
  "pattern": "^[A-Z_]{1,32}$",
8125
- "title": "transactionSubScenario",
8126
- "type": "string"
8104
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
8105
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
8127
8106
  }
8128
8107
  },
8129
8108
  "required": [
@@ -8436,11 +8415,11 @@
8436
8415
  "type": "string"
8437
8416
  },
8438
8417
  "subScenario": {
8439
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
8440
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
8418
+ "title": "TransactionSubScenario",
8419
+ "type": "string",
8441
8420
  "pattern": "^[A-Z_]{1,32}$",
8442
- "title": "transactionSubScenario",
8443
- "type": "string"
8421
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
8422
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
8444
8423
  },
8445
8424
  "timestamp": {
8446
8425
  "description": "An ISO-8601 formatted timestamp.",
@@ -9129,9 +9108,9 @@
9129
9108
  "type": "object"
9130
9109
  },
9131
9110
  "payee": {
9132
- "description": "Data model for the complex type Party.",
9133
9111
  "title": "Party",
9134
9112
  "type": "object",
9113
+ "description": "Data model for the complex type Party.",
9135
9114
  "properties": {
9136
9115
  "partyIdInfo": {
9137
9116
  "title": "PartyIdInfo",
@@ -9289,9 +9268,9 @@
9289
9268
  ]
9290
9269
  },
9291
9270
  "payer": {
9292
- "description": "Data model for the complex type Party.",
9293
9271
  "title": "Party",
9294
9272
  "type": "object",
9273
+ "description": "Data model for the complex type Party.",
9295
9274
  "properties": {
9296
9275
  "partyIdInfo": {
9297
9276
  "title": "PartyIdInfo",
@@ -9469,7 +9448,6 @@
9469
9448
  "type": "string"
9470
9449
  },
9471
9450
  "initiatorType": {
9472
- "description": "Specifies the type of the transaction initiator.",
9473
9451
  "enum": [
9474
9452
  "CONSUMER",
9475
9453
  "AGENT",
@@ -9485,11 +9463,11 @@
9485
9463
  "type": "string"
9486
9464
  },
9487
9465
  "subScenario": {
9488
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
9489
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
9466
+ "title": "TransactionSubScenario",
9467
+ "type": "string",
9490
9468
  "pattern": "^[A-Z_]{1,32}$",
9491
- "title": "transactionSubScenario",
9492
- "type": "string"
9469
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
9470
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
9493
9471
  }
9494
9472
  },
9495
9473
  "required": [
@@ -9569,12 +9547,10 @@
9569
9547
  "type": "object"
9570
9548
  },
9571
9549
  "payeeFspCommissionAmount": {
9572
- "description": "Transaction commission from the Payee FSP.",
9573
9550
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
9574
9551
  "type": "string"
9575
9552
  },
9576
9553
  "payeeFspCommissionAmountCurrency": {
9577
- "description": "Currency of the `payeeFspCommissionAmount`.",
9578
9554
  "enum": [
9579
9555
  "AED",
9580
9556
  "AFN",
@@ -9746,12 +9722,10 @@
9746
9722
  "type": "string"
9747
9723
  },
9748
9724
  "payeeFspFeeAmount": {
9749
- "description": "Payee FSP’s part of the transaction fee.",
9750
9725
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
9751
9726
  "type": "string"
9752
9727
  },
9753
9728
  "payeeFspFeeAmountCurrency": {
9754
- "description": "The currency of the `payeeFspFeeAmount`.",
9755
9729
  "enum": [
9756
9730
  "AED",
9757
9731
  "AFN",
@@ -9923,12 +9897,10 @@
9923
9897
  "type": "string"
9924
9898
  },
9925
9899
  "payeeReceiveAmount": {
9926
- "description": "The amount that the Payee should receive in the end-to-end transaction. Optional as the Payee FSP might not want to disclose any optional Payee fees.",
9927
9900
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
9928
9901
  "type": "string"
9929
9902
  },
9930
9903
  "payeeReceiveAmountCurrency": {
9931
- "description": "The currency of the `payeeReceiveAmount`.",
9932
9904
  "enum": [
9933
9905
  "AED",
9934
9906
  "AFN",
@@ -10110,12 +10082,10 @@
10110
10082
  "type": "string"
10111
10083
  },
10112
10084
  "transferAmount": {
10113
- "description": "The amount of money that the Payer FSP should transfer to the Payee FSP.",
10114
10085
  "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
10115
10086
  "type": "string"
10116
10087
  },
10117
10088
  "transferAmountCurrency": {
10118
- "description": "The currency of the `transferAmount`.",
10119
10089
  "enum": [
10120
10090
  "AED",
10121
10091
  "AFN",
@@ -10316,11 +10286,11 @@
10316
10286
  "type": "array"
10317
10287
  },
10318
10288
  "subScenario": {
10319
- "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.",
10320
- "example": "LOCALLY_DEFINED_SUBSCENARIO",
10289
+ "title": "TransactionSubScenario",
10290
+ "type": "string",
10321
10291
  "pattern": "^[A-Z_]{1,32}$",
10322
- "title": "transactionSubScenario",
10323
- "type": "string"
10292
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
10293
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
10324
10294
  },
10325
10295
  "to": {
10326
10296
  "properties": {
@@ -10443,16 +10413,15 @@
10443
10413
  "properties": {
10444
10414
  "completedTimestamp": {
10445
10415
  "description": "An ISO-8601 formatted timestamp.",
10446
- "example": "2020-05-19T08:38:08.699-04:00",
10447
10416
  "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$",
10448
10417
  "type": "string"
10449
10418
  },
10450
10419
  "fulfilment": {
10451
- "description": "Fulfilment that must be attached to the transfer by the Payee.",
10452
10420
  "title": "IlpFulfilment",
10453
10421
  "type": "string",
10454
10422
  "pattern": "^[A-Za-z0-9-_]{43}$",
10455
10423
  "maxLength": 48,
10424
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
10456
10425
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
10457
10426
  },
10458
10427
  "homeTransactionId": {
@@ -10461,7 +10430,6 @@
10461
10430
  },
10462
10431
  "transferState": {
10463
10432
  "description": "Below are the allowed values for the enumeration - RECEIVED DFSP has received the transfer. - RESERVED DFSP has reserved the transfer. - COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP has aborted the transfer due a rejection or failure to perform the transfer.\n",
10464
- "example": "ABORTED",
10465
10433
  "enum": [
10466
10434
  "RECEIVED",
10467
10435
  "RESERVED",
@@ -10495,6 +10463,13 @@
10495
10463
  ],
10496
10464
  "type": "string"
10497
10465
  },
10466
+ "TransactionSubScenario": {
10467
+ "title": "TransactionSubScenario",
10468
+ "type": "string",
10469
+ "pattern": "^[A-Z_]{1,32}$",
10470
+ "description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
10471
+ "example": "LOCALLY_DEFINED_SUBSCENARIO"
10472
+ },
10498
10473
  "CorrelationId": {
10499
10474
  "title": "CorrelationId",
10500
10475
  "type": "string",
@@ -12080,203 +12055,250 @@
12080
12055
  "maxLength": 48,
12081
12056
  "description": "Condition that must be attached to the transfer by the Payer."
12082
12057
  },
12083
- "QuotesIDPutResponse": {
12084
- "title": "QuotesIDPutResponse",
12058
+ "ErrorCode": {
12059
+ "title": "ErrorCode",
12060
+ "type": "string",
12061
+ "pattern": "^[1-9]\\d{3}$",
12062
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
12063
+ "example": "5100"
12064
+ },
12065
+ "ErrorDescription": {
12066
+ "title": "ErrorDescription",
12067
+ "type": "string",
12068
+ "minLength": 1,
12069
+ "maxLength": 128,
12070
+ "description": "Error description string."
12071
+ },
12072
+ "ErrorInformation": {
12073
+ "title": "ErrorInformation",
12085
12074
  "type": "object",
12086
- "description": "The object sent in the PUT /quotes/{ID} callback.",
12075
+ "description": "Data model for the complex type ErrorInformation.",
12087
12076
  "properties": {
12088
- "transferAmount": {
12089
- "title": "Money",
12077
+ "errorCode": {
12078
+ "title": "ErrorCode",
12079
+ "type": "string",
12080
+ "pattern": "^[1-9]\\d{3}$",
12081
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
12082
+ "example": "5100"
12083
+ },
12084
+ "errorDescription": {
12085
+ "title": "ErrorDescription",
12086
+ "type": "string",
12087
+ "minLength": 1,
12088
+ "maxLength": 128,
12089
+ "description": "Error description string."
12090
+ },
12091
+ "extensionList": {
12092
+ "title": "ExtensionList",
12090
12093
  "type": "object",
12091
- "description": "Data model for the complex type Money.",
12094
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
12092
12095
  "properties": {
12093
- "currency": {
12094
- "title": "Currency",
12095
- "description": "The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies.",
12096
+ "extension": {
12097
+ "type": "array",
12098
+ "items": {
12099
+ "title": "Extension",
12100
+ "type": "object",
12101
+ "description": "Data model for the complex type Extension.",
12102
+ "properties": {
12103
+ "key": {
12104
+ "title": "ExtensionKey",
12105
+ "type": "string",
12106
+ "minLength": 1,
12107
+ "maxLength": 32,
12108
+ "description": "Extension key."
12109
+ },
12110
+ "value": {
12111
+ "title": "ExtensionValue",
12112
+ "type": "string",
12113
+ "minLength": 1,
12114
+ "maxLength": 128,
12115
+ "description": "Extension value."
12116
+ }
12117
+ },
12118
+ "required": [
12119
+ "key",
12120
+ "value"
12121
+ ]
12122
+ },
12123
+ "minItems": 1,
12124
+ "maxItems": 16,
12125
+ "description": "Number of Extension elements."
12126
+ }
12127
+ },
12128
+ "required": [
12129
+ "extension"
12130
+ ]
12131
+ }
12132
+ },
12133
+ "required": [
12134
+ "errorCode",
12135
+ "errorDescription"
12136
+ ]
12137
+ },
12138
+ "mojaloopError": {
12139
+ "type": "object",
12140
+ "properties": {
12141
+ "errorInformation": {
12142
+ "title": "ErrorInformation",
12143
+ "type": "object",
12144
+ "description": "Data model for the complex type ErrorInformation.",
12145
+ "properties": {
12146
+ "errorCode": {
12147
+ "title": "ErrorCode",
12096
12148
  "type": "string",
12097
- "minLength": 3,
12098
- "maxLength": 3,
12099
- "enum": [
12100
- "AED",
12101
- "AFN",
12102
- "ALL",
12103
- "AMD",
12104
- "ANG",
12105
- "AOA",
12106
- "ARS",
12107
- "AUD",
12108
- "AWG",
12109
- "AZN",
12110
- "BAM",
12111
- "BBD",
12112
- "BDT",
12113
- "BGN",
12114
- "BHD",
12115
- "BIF",
12116
- "BMD",
12117
- "BND",
12118
- "BOB",
12119
- "BRL",
12120
- "BSD",
12121
- "BTN",
12122
- "BWP",
12123
- "BYN",
12124
- "BZD",
12125
- "CAD",
12126
- "CDF",
12127
- "CHF",
12128
- "CLP",
12129
- "CNY",
12130
- "COP",
12131
- "CRC",
12132
- "CUC",
12133
- "CUP",
12134
- "CVE",
12135
- "CZK",
12136
- "DJF",
12137
- "DKK",
12138
- "DOP",
12139
- "DZD",
12140
- "EGP",
12141
- "ERN",
12142
- "ETB",
12143
- "EUR",
12144
- "FJD",
12145
- "FKP",
12146
- "GBP",
12147
- "GEL",
12148
- "GGP",
12149
- "GHS",
12150
- "GIP",
12151
- "GMD",
12152
- "GNF",
12153
- "GTQ",
12154
- "GYD",
12155
- "HKD",
12156
- "HNL",
12157
- "HRK",
12158
- "HTG",
12159
- "HUF",
12160
- "IDR",
12161
- "ILS",
12162
- "IMP",
12163
- "INR",
12164
- "IQD",
12165
- "IRR",
12166
- "ISK",
12167
- "JEP",
12168
- "JMD",
12169
- "JOD",
12170
- "JPY",
12171
- "KES",
12172
- "KGS",
12173
- "KHR",
12174
- "KMF",
12175
- "KPW",
12176
- "KRW",
12177
- "KWD",
12178
- "KYD",
12179
- "KZT",
12180
- "LAK",
12181
- "LBP",
12182
- "LKR",
12183
- "LRD",
12184
- "LSL",
12185
- "LYD",
12186
- "MAD",
12187
- "MDL",
12188
- "MGA",
12189
- "MKD",
12190
- "MMK",
12191
- "MNT",
12192
- "MOP",
12193
- "MRO",
12194
- "MUR",
12195
- "MVR",
12196
- "MWK",
12197
- "MXN",
12198
- "MYR",
12199
- "MZN",
12200
- "NAD",
12201
- "NGN",
12202
- "NIO",
12203
- "NOK",
12204
- "NPR",
12205
- "NZD",
12206
- "OMR",
12207
- "PAB",
12208
- "PEN",
12209
- "PGK",
12210
- "PHP",
12211
- "PKR",
12212
- "PLN",
12213
- "PYG",
12214
- "QAR",
12215
- "RON",
12216
- "RSD",
12217
- "RUB",
12218
- "RWF",
12219
- "SAR",
12220
- "SBD",
12221
- "SCR",
12222
- "SDG",
12223
- "SEK",
12224
- "SGD",
12225
- "SHP",
12226
- "SLL",
12227
- "SOS",
12228
- "SPL",
12229
- "SRD",
12230
- "STD",
12231
- "SVC",
12232
- "SYP",
12233
- "SZL",
12234
- "THB",
12235
- "TJS",
12236
- "TMT",
12237
- "TND",
12238
- "TOP",
12239
- "TRY",
12240
- "TTD",
12241
- "TVD",
12242
- "TWD",
12243
- "TZS",
12244
- "UAH",
12245
- "UGX",
12246
- "USD",
12247
- "UYU",
12248
- "UZS",
12249
- "VEF",
12250
- "VND",
12251
- "VUV",
12252
- "WST",
12253
- "XAF",
12254
- "XCD",
12255
- "XDR",
12256
- "XOF",
12257
- "XPF",
12258
- "XTS",
12259
- "XXX",
12260
- "YER",
12261
- "ZAR",
12262
- "ZMW",
12263
- "ZWD"
12264
- ]
12149
+ "pattern": "^[1-9]\\d{3}$",
12150
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
12151
+ "example": "5100"
12265
12152
  },
12266
- "amount": {
12267
- "title": "Amount",
12153
+ "errorDescription": {
12154
+ "title": "ErrorDescription",
12268
12155
  "type": "string",
12269
- "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
12270
- "description": "The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed.",
12271
- "example": "123.45"
12156
+ "minLength": 1,
12157
+ "maxLength": 128,
12158
+ "description": "Error description string."
12159
+ },
12160
+ "extensionList": {
12161
+ "title": "ExtensionList",
12162
+ "type": "object",
12163
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
12164
+ "properties": {
12165
+ "extension": {
12166
+ "type": "array",
12167
+ "items": {
12168
+ "title": "Extension",
12169
+ "type": "object",
12170
+ "description": "Data model for the complex type Extension.",
12171
+ "properties": {
12172
+ "key": {
12173
+ "title": "ExtensionKey",
12174
+ "type": "string",
12175
+ "minLength": 1,
12176
+ "maxLength": 32,
12177
+ "description": "Extension key."
12178
+ },
12179
+ "value": {
12180
+ "title": "ExtensionValue",
12181
+ "type": "string",
12182
+ "minLength": 1,
12183
+ "maxLength": 128,
12184
+ "description": "Extension value."
12185
+ }
12186
+ },
12187
+ "required": [
12188
+ "key",
12189
+ "value"
12190
+ ]
12191
+ },
12192
+ "minItems": 1,
12193
+ "maxItems": 16,
12194
+ "description": "Number of Extension elements."
12195
+ }
12196
+ },
12197
+ "required": [
12198
+ "extension"
12199
+ ]
12272
12200
  }
12273
12201
  },
12274
12202
  "required": [
12275
- "currency",
12276
- "amount"
12203
+ "errorCode",
12204
+ "errorDescription"
12277
12205
  ]
12206
+ }
12207
+ }
12208
+ },
12209
+ "quoteError": {
12210
+ "type": "object",
12211
+ "description": "This object represents a Mojaloop API error received at any time during the quote process",
12212
+ "properties": {
12213
+ "httpStatusCode": {
12214
+ "type": "integer",
12215
+ "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
12278
12216
  },
12279
- "payeeReceiveAmount": {
12217
+ "mojaloopError": {
12218
+ "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
12219
+ "type": "object",
12220
+ "properties": {
12221
+ "errorInformation": {
12222
+ "title": "ErrorInformation",
12223
+ "type": "object",
12224
+ "description": "Data model for the complex type ErrorInformation.",
12225
+ "properties": {
12226
+ "errorCode": {
12227
+ "title": "ErrorCode",
12228
+ "type": "string",
12229
+ "pattern": "^[1-9]\\d{3}$",
12230
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
12231
+ "example": "5100"
12232
+ },
12233
+ "errorDescription": {
12234
+ "title": "ErrorDescription",
12235
+ "type": "string",
12236
+ "minLength": 1,
12237
+ "maxLength": 128,
12238
+ "description": "Error description string."
12239
+ },
12240
+ "extensionList": {
12241
+ "title": "ExtensionList",
12242
+ "type": "object",
12243
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
12244
+ "properties": {
12245
+ "extension": {
12246
+ "type": "array",
12247
+ "items": {
12248
+ "title": "Extension",
12249
+ "type": "object",
12250
+ "description": "Data model for the complex type Extension.",
12251
+ "properties": {
12252
+ "key": {
12253
+ "title": "ExtensionKey",
12254
+ "type": "string",
12255
+ "minLength": 1,
12256
+ "maxLength": 32,
12257
+ "description": "Extension key."
12258
+ },
12259
+ "value": {
12260
+ "title": "ExtensionValue",
12261
+ "type": "string",
12262
+ "minLength": 1,
12263
+ "maxLength": 128,
12264
+ "description": "Extension value."
12265
+ }
12266
+ },
12267
+ "required": [
12268
+ "key",
12269
+ "value"
12270
+ ]
12271
+ },
12272
+ "minItems": 1,
12273
+ "maxItems": 16,
12274
+ "description": "Number of Extension elements."
12275
+ }
12276
+ },
12277
+ "required": [
12278
+ "extension"
12279
+ ]
12280
+ }
12281
+ },
12282
+ "required": [
12283
+ "errorCode",
12284
+ "errorDescription"
12285
+ ]
12286
+ }
12287
+ }
12288
+ }
12289
+ }
12290
+ },
12291
+ "individualQuoteResult": {
12292
+ "type": "object",
12293
+ "properties": {
12294
+ "quoteId": {
12295
+ "title": "CorrelationId",
12296
+ "type": "string",
12297
+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
12298
+ "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
12299
+ "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
12300
+ },
12301
+ "transferAmount": {
12280
12302
  "title": "Money",
12281
12303
  "type": "object",
12282
12304
  "description": "Data model for the complex type Money.",
@@ -12467,7 +12489,7 @@
12467
12489
  "amount"
12468
12490
  ]
12469
12491
  },
12470
- "payeeFspFee": {
12492
+ "payeeReceiveAmount": {
12471
12493
  "title": "Money",
12472
12494
  "type": "object",
12473
12495
  "description": "Data model for the complex type Money.",
@@ -12658,7 +12680,7 @@
12658
12680
  "amount"
12659
12681
  ]
12660
12682
  },
12661
- "payeeFspCommission": {
12683
+ "payeeFspFee": {
12662
12684
  "title": "Money",
12663
12685
  "type": "object",
12664
12686
  "description": "Data model for the complex type Money.",
@@ -12849,154 +12871,237 @@
12849
12871
  "amount"
12850
12872
  ]
12851
12873
  },
12852
- "expiration": {
12853
- "title": "DateTime",
12854
- "type": "string",
12855
- "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$",
12856
- "description": "The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are \"2016-05-24T08:38:08.699-04:00\", \"2016-05-24T08:38:08.699Z\" (where Z indicates Zulu time zone, same as UTC).",
12857
- "example": "2016-05-24T08:38:08.699-04:00"
12858
- },
12859
- "geoCode": {
12860
- "title": "GeoCode",
12874
+ "payeeFspCommission": {
12875
+ "title": "Money",
12861
12876
  "type": "object",
12862
- "description": "Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.",
12877
+ "description": "Data model for the complex type Money.",
12863
12878
  "properties": {
12864
- "latitude": {
12865
- "title": "Latitude",
12866
- "type": "string",
12867
- "pattern": "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$",
12868
- "description": "The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.",
12869
- "example": "+45.4215"
12870
- },
12871
- "longitude": {
12872
- "title": "Longitude",
12879
+ "currency": {
12880
+ "title": "Currency",
12881
+ "description": "The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies.",
12873
12882
  "type": "string",
12874
- "pattern": "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,6})?))$",
12875
- "description": "The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.",
12876
- "example": "+75.6972"
12877
- }
12878
- },
12879
- "required": [
12880
- "latitude",
12881
- "longitude"
12882
- ]
12883
- },
12884
- "ilpPacket": {
12885
- "title": "IlpPacket",
12886
- "type": "string",
12887
- "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$",
12888
- "minLength": 1,
12889
- "maxLength": 32768,
12890
- "description": "Information for recipient (transport layer information).",
12891
- "example": "AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA"
12892
- },
12893
- "condition": {
12894
- "title": "IlpCondition",
12895
- "type": "string",
12896
- "pattern": "^[A-Za-z0-9-_]{43}$",
12897
- "maxLength": 48,
12898
- "description": "Condition that must be attached to the transfer by the Payer."
12899
- },
12900
- "extensionList": {
12901
- "title": "ExtensionList",
12902
- "type": "object",
12903
- "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
12904
- "properties": {
12905
- "extension": {
12906
- "type": "array",
12907
- "items": {
12908
- "title": "Extension",
12909
- "type": "object",
12910
- "description": "Data model for the complex type Extension.",
12911
- "properties": {
12912
- "key": {
12913
- "title": "ExtensionKey",
12914
- "type": "string",
12915
- "minLength": 1,
12916
- "maxLength": 32,
12917
- "description": "Extension key."
12918
- },
12919
- "value": {
12920
- "title": "ExtensionValue",
12921
- "type": "string",
12922
- "minLength": 1,
12923
- "maxLength": 128,
12924
- "description": "Extension value."
12925
- }
12926
- },
12927
- "required": [
12928
- "key",
12929
- "value"
12930
- ]
12931
- },
12932
- "minItems": 1,
12933
- "maxItems": 16,
12934
- "description": "Number of Extension elements."
12883
+ "minLength": 3,
12884
+ "maxLength": 3,
12885
+ "enum": [
12886
+ "AED",
12887
+ "AFN",
12888
+ "ALL",
12889
+ "AMD",
12890
+ "ANG",
12891
+ "AOA",
12892
+ "ARS",
12893
+ "AUD",
12894
+ "AWG",
12895
+ "AZN",
12896
+ "BAM",
12897
+ "BBD",
12898
+ "BDT",
12899
+ "BGN",
12900
+ "BHD",
12901
+ "BIF",
12902
+ "BMD",
12903
+ "BND",
12904
+ "BOB",
12905
+ "BRL",
12906
+ "BSD",
12907
+ "BTN",
12908
+ "BWP",
12909
+ "BYN",
12910
+ "BZD",
12911
+ "CAD",
12912
+ "CDF",
12913
+ "CHF",
12914
+ "CLP",
12915
+ "CNY",
12916
+ "COP",
12917
+ "CRC",
12918
+ "CUC",
12919
+ "CUP",
12920
+ "CVE",
12921
+ "CZK",
12922
+ "DJF",
12923
+ "DKK",
12924
+ "DOP",
12925
+ "DZD",
12926
+ "EGP",
12927
+ "ERN",
12928
+ "ETB",
12929
+ "EUR",
12930
+ "FJD",
12931
+ "FKP",
12932
+ "GBP",
12933
+ "GEL",
12934
+ "GGP",
12935
+ "GHS",
12936
+ "GIP",
12937
+ "GMD",
12938
+ "GNF",
12939
+ "GTQ",
12940
+ "GYD",
12941
+ "HKD",
12942
+ "HNL",
12943
+ "HRK",
12944
+ "HTG",
12945
+ "HUF",
12946
+ "IDR",
12947
+ "ILS",
12948
+ "IMP",
12949
+ "INR",
12950
+ "IQD",
12951
+ "IRR",
12952
+ "ISK",
12953
+ "JEP",
12954
+ "JMD",
12955
+ "JOD",
12956
+ "JPY",
12957
+ "KES",
12958
+ "KGS",
12959
+ "KHR",
12960
+ "KMF",
12961
+ "KPW",
12962
+ "KRW",
12963
+ "KWD",
12964
+ "KYD",
12965
+ "KZT",
12966
+ "LAK",
12967
+ "LBP",
12968
+ "LKR",
12969
+ "LRD",
12970
+ "LSL",
12971
+ "LYD",
12972
+ "MAD",
12973
+ "MDL",
12974
+ "MGA",
12975
+ "MKD",
12976
+ "MMK",
12977
+ "MNT",
12978
+ "MOP",
12979
+ "MRO",
12980
+ "MUR",
12981
+ "MVR",
12982
+ "MWK",
12983
+ "MXN",
12984
+ "MYR",
12985
+ "MZN",
12986
+ "NAD",
12987
+ "NGN",
12988
+ "NIO",
12989
+ "NOK",
12990
+ "NPR",
12991
+ "NZD",
12992
+ "OMR",
12993
+ "PAB",
12994
+ "PEN",
12995
+ "PGK",
12996
+ "PHP",
12997
+ "PKR",
12998
+ "PLN",
12999
+ "PYG",
13000
+ "QAR",
13001
+ "RON",
13002
+ "RSD",
13003
+ "RUB",
13004
+ "RWF",
13005
+ "SAR",
13006
+ "SBD",
13007
+ "SCR",
13008
+ "SDG",
13009
+ "SEK",
13010
+ "SGD",
13011
+ "SHP",
13012
+ "SLL",
13013
+ "SOS",
13014
+ "SPL",
13015
+ "SRD",
13016
+ "STD",
13017
+ "SVC",
13018
+ "SYP",
13019
+ "SZL",
13020
+ "THB",
13021
+ "TJS",
13022
+ "TMT",
13023
+ "TND",
13024
+ "TOP",
13025
+ "TRY",
13026
+ "TTD",
13027
+ "TVD",
13028
+ "TWD",
13029
+ "TZS",
13030
+ "UAH",
13031
+ "UGX",
13032
+ "USD",
13033
+ "UYU",
13034
+ "UZS",
13035
+ "VEF",
13036
+ "VND",
13037
+ "VUV",
13038
+ "WST",
13039
+ "XAF",
13040
+ "XCD",
13041
+ "XDR",
13042
+ "XOF",
13043
+ "XPF",
13044
+ "XTS",
13045
+ "XXX",
13046
+ "YER",
13047
+ "ZAR",
13048
+ "ZMW",
13049
+ "ZWD"
13050
+ ]
13051
+ },
13052
+ "amount": {
13053
+ "title": "Amount",
13054
+ "type": "string",
13055
+ "pattern": "^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$",
13056
+ "description": "The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed.",
13057
+ "example": "123.45"
12935
13058
  }
12936
13059
  },
12937
13060
  "required": [
12938
- "extension"
13061
+ "currency",
13062
+ "amount"
12939
13063
  ]
12940
- }
12941
- },
12942
- "required": [
12943
- "transferAmount",
12944
- "expiration",
12945
- "ilpPacket",
12946
- "condition"
12947
- ]
12948
- },
12949
- "IlpFulfilment": {
12950
- "title": "IlpFulfilment",
12951
- "type": "string",
12952
- "pattern": "^[A-Za-z0-9-_]{43}$",
12953
- "maxLength": 48,
12954
- "description": "Fulfilment that must be attached to the transfer by the Payee.",
12955
- "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
12956
- },
12957
- "TransferState": {
12958
- "title": "TransferState",
12959
- "type": "string",
12960
- "enum": [
12961
- "RECEIVED",
12962
- "RESERVED",
12963
- "COMMITTED",
12964
- "ABORTED"
12965
- ],
12966
- "description": "Below are the allowed values for the enumeration.\n- RECEIVED - Next ledger has received the transfer.\n- RESERVED - Next ledger has reserved the transfer.\n- COMMITTED - Next ledger has successfully performed the transfer.\n- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.",
12967
- "example": "RESERVED"
12968
- },
12969
- "TransfersIDPutResponse": {
12970
- "title": "TransfersIDPutResponse",
12971
- "type": "object",
12972
- "description": "The object sent in the PUT /transfers/{ID} callback.",
12973
- "properties": {
12974
- "fulfilment": {
12975
- "title": "IlpFulfilment",
12976
- "type": "string",
12977
- "pattern": "^[A-Za-z0-9-_]{43}$",
12978
- "maxLength": 48,
12979
- "description": "Fulfilment that must be attached to the transfer by the Payee.",
12980
- "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
12981
13064
  },
12982
- "completedTimestamp": {
12983
- "title": "DateTime",
13065
+ "geoCode": {
13066
+ "title": "GeoCode",
13067
+ "type": "object",
13068
+ "description": "Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.",
13069
+ "properties": {
13070
+ "latitude": {
13071
+ "title": "Latitude",
13072
+ "type": "string",
13073
+ "pattern": "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$",
13074
+ "description": "The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.",
13075
+ "example": "+45.4215"
13076
+ },
13077
+ "longitude": {
13078
+ "title": "Longitude",
13079
+ "type": "string",
13080
+ "pattern": "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,6})?))$",
13081
+ "description": "The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.",
13082
+ "example": "+75.6972"
13083
+ }
13084
+ },
13085
+ "required": [
13086
+ "latitude",
13087
+ "longitude"
13088
+ ]
13089
+ },
13090
+ "ilpPacket": {
13091
+ "title": "IlpPacket",
12984
13092
  "type": "string",
12985
- "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$",
12986
- "description": "The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are \"2016-05-24T08:38:08.699-04:00\", \"2016-05-24T08:38:08.699Z\" (where Z indicates Zulu time zone, same as UTC).",
12987
- "example": "2016-05-24T08:38:08.699-04:00"
13093
+ "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$",
13094
+ "minLength": 1,
13095
+ "maxLength": 32768,
13096
+ "description": "Information for recipient (transport layer information).",
13097
+ "example": "AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA"
12988
13098
  },
12989
- "transferState": {
12990
- "title": "TransferState",
13099
+ "condition": {
13100
+ "title": "IlpCondition",
12991
13101
  "type": "string",
12992
- "enum": [
12993
- "RECEIVED",
12994
- "RESERVED",
12995
- "COMMITTED",
12996
- "ABORTED"
12997
- ],
12998
- "description": "Below are the allowed values for the enumeration.\n- RECEIVED - Next ledger has received the transfer.\n- RESERVED - Next ledger has reserved the transfer.\n- COMMITTED - Next ledger has successfully performed the transfer.\n- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.",
12999
- "example": "RESERVED"
13102
+ "pattern": "^[A-Za-z0-9-_]{43}$",
13103
+ "maxLength": 48,
13104
+ "description": "Condition that must be attached to the transfer by the Payer."
13000
13105
  },
13001
13106
  "extensionList": {
13002
13107
  "title": "ExtensionList",
@@ -13038,162 +13143,104 @@
13038
13143
  "required": [
13039
13144
  "extension"
13040
13145
  ]
13041
- }
13042
- },
13043
- "required": [
13044
- "transferState"
13045
- ]
13046
- },
13047
- "ErrorCode": {
13048
- "title": "ErrorCode",
13049
- "type": "string",
13050
- "pattern": "^[1-9]\\d{3}$",
13051
- "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
13052
- "example": "5100"
13053
- },
13054
- "ErrorDescription": {
13055
- "title": "ErrorDescription",
13056
- "type": "string",
13057
- "minLength": 1,
13058
- "maxLength": 128,
13059
- "description": "Error description string."
13060
- },
13061
- "ErrorInformation": {
13062
- "title": "ErrorInformation",
13063
- "type": "object",
13064
- "description": "Data model for the complex type ErrorInformation.",
13065
- "properties": {
13066
- "errorCode": {
13067
- "title": "ErrorCode",
13068
- "type": "string",
13069
- "pattern": "^[1-9]\\d{3}$",
13070
- "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
13071
- "example": "5100"
13072
13146
  },
13073
- "errorDescription": {
13074
- "title": "ErrorDescription",
13075
- "type": "string",
13076
- "minLength": 1,
13077
- "maxLength": 128,
13078
- "description": "Error description string."
13079
- },
13080
- "extensionList": {
13081
- "title": "ExtensionList",
13147
+ "lastError": {
13148
+ "description": "Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.\n",
13082
13149
  "type": "object",
13083
- "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
13084
13150
  "properties": {
13085
- "extension": {
13086
- "type": "array",
13087
- "items": {
13088
- "title": "Extension",
13089
- "type": "object",
13090
- "description": "Data model for the complex type Extension.",
13091
- "properties": {
13092
- "key": {
13093
- "title": "ExtensionKey",
13094
- "type": "string",
13095
- "minLength": 1,
13096
- "maxLength": 32,
13097
- "description": "Extension key."
13151
+ "httpStatusCode": {
13152
+ "type": "integer",
13153
+ "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
13154
+ },
13155
+ "mojaloopError": {
13156
+ "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
13157
+ "type": "object",
13158
+ "properties": {
13159
+ "errorInformation": {
13160
+ "title": "ErrorInformation",
13161
+ "type": "object",
13162
+ "description": "Data model for the complex type ErrorInformation.",
13163
+ "properties": {
13164
+ "errorCode": {
13165
+ "title": "ErrorCode",
13166
+ "type": "string",
13167
+ "pattern": "^[1-9]\\d{3}$",
13168
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
13169
+ "example": "5100"
13170
+ },
13171
+ "errorDescription": {
13172
+ "title": "ErrorDescription",
13173
+ "type": "string",
13174
+ "minLength": 1,
13175
+ "maxLength": 128,
13176
+ "description": "Error description string."
13177
+ },
13178
+ "extensionList": {
13179
+ "title": "ExtensionList",
13180
+ "type": "object",
13181
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
13182
+ "properties": {
13183
+ "extension": {
13184
+ "type": "array",
13185
+ "items": {
13186
+ "title": "Extension",
13187
+ "type": "object",
13188
+ "description": "Data model for the complex type Extension.",
13189
+ "properties": {
13190
+ "key": {
13191
+ "title": "ExtensionKey",
13192
+ "type": "string",
13193
+ "minLength": 1,
13194
+ "maxLength": 32,
13195
+ "description": "Extension key."
13196
+ },
13197
+ "value": {
13198
+ "title": "ExtensionValue",
13199
+ "type": "string",
13200
+ "minLength": 1,
13201
+ "maxLength": 128,
13202
+ "description": "Extension value."
13203
+ }
13204
+ },
13205
+ "required": [
13206
+ "key",
13207
+ "value"
13208
+ ]
13209
+ },
13210
+ "minItems": 1,
13211
+ "maxItems": 16,
13212
+ "description": "Number of Extension elements."
13213
+ }
13214
+ },
13215
+ "required": [
13216
+ "extension"
13217
+ ]
13218
+ }
13098
13219
  },
13099
- "value": {
13100
- "title": "ExtensionValue",
13101
- "type": "string",
13102
- "minLength": 1,
13103
- "maxLength": 128,
13104
- "description": "Extension value."
13105
- }
13106
- },
13107
- "required": [
13108
- "key",
13109
- "value"
13110
- ]
13111
- },
13112
- "minItems": 1,
13113
- "maxItems": 16,
13114
- "description": "Number of Extension elements."
13220
+ "required": [
13221
+ "errorCode",
13222
+ "errorDescription"
13223
+ ]
13224
+ }
13225
+ }
13115
13226
  }
13116
- },
13117
- "required": [
13118
- "extension"
13119
- ]
13227
+ }
13120
13228
  }
13121
13229
  },
13122
13230
  "required": [
13123
- "errorCode",
13124
- "errorDescription"
13231
+ "quoteId",
13232
+ "transferAmount",
13233
+ "ilpPacket",
13234
+ "condition"
13125
13235
  ]
13126
13236
  },
13127
- "mojaloopError": {
13128
- "type": "object",
13129
- "properties": {
13130
- "errorInformation": {
13131
- "title": "ErrorInformation",
13132
- "type": "object",
13133
- "description": "Data model for the complex type ErrorInformation.",
13134
- "properties": {
13135
- "errorCode": {
13136
- "title": "ErrorCode",
13137
- "type": "string",
13138
- "pattern": "^[1-9]\\d{3}$",
13139
- "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
13140
- "example": "5100"
13141
- },
13142
- "errorDescription": {
13143
- "title": "ErrorDescription",
13144
- "type": "string",
13145
- "minLength": 1,
13146
- "maxLength": 128,
13147
- "description": "Error description string."
13148
- },
13149
- "extensionList": {
13150
- "title": "ExtensionList",
13151
- "type": "object",
13152
- "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
13153
- "properties": {
13154
- "extension": {
13155
- "type": "array",
13156
- "items": {
13157
- "title": "Extension",
13158
- "type": "object",
13159
- "description": "Data model for the complex type Extension.",
13160
- "properties": {
13161
- "key": {
13162
- "title": "ExtensionKey",
13163
- "type": "string",
13164
- "minLength": 1,
13165
- "maxLength": 32,
13166
- "description": "Extension key."
13167
- },
13168
- "value": {
13169
- "title": "ExtensionValue",
13170
- "type": "string",
13171
- "minLength": 1,
13172
- "maxLength": 128,
13173
- "description": "Extension value."
13174
- }
13175
- },
13176
- "required": [
13177
- "key",
13178
- "value"
13179
- ]
13180
- },
13181
- "minItems": 1,
13182
- "maxItems": 16,
13183
- "description": "Number of Extension elements."
13184
- }
13185
- },
13186
- "required": [
13187
- "extension"
13188
- ]
13189
- }
13190
- },
13191
- "required": [
13192
- "errorCode",
13193
- "errorDescription"
13194
- ]
13195
- }
13196
- }
13237
+ "IlpFulfilment": {
13238
+ "title": "IlpFulfilment",
13239
+ "type": "string",
13240
+ "pattern": "^[A-Za-z0-9-_]{43}$",
13241
+ "maxLength": 48,
13242
+ "description": "Fulfilment that must be attached to the transfer by the Payee.",
13243
+ "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
13197
13244
  },
13198
13245
  "transferError": {
13199
13246
  "type": "object",
@@ -13277,15 +13324,156 @@
13277
13324
  }
13278
13325
  }
13279
13326
  },
13327
+ "individualTransferResult": {
13328
+ "type": "object",
13329
+ "required": [
13330
+ "transferId"
13331
+ ],
13332
+ "properties": {
13333
+ "transferId": {
13334
+ "title": "CorrelationId",
13335
+ "type": "string",
13336
+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
13337
+ "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
13338
+ "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
13339
+ },
13340
+ "fulfilment": {
13341
+ "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
13342
+ "title": "IlpFulfilment",
13343
+ "type": "string",
13344
+ "pattern": "^[A-Za-z0-9-_]{43}$",
13345
+ "maxLength": 48,
13346
+ "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
13347
+ },
13348
+ "extensionList": {
13349
+ "title": "ExtensionList",
13350
+ "type": "object",
13351
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
13352
+ "properties": {
13353
+ "extension": {
13354
+ "type": "array",
13355
+ "items": {
13356
+ "title": "Extension",
13357
+ "type": "object",
13358
+ "description": "Data model for the complex type Extension.",
13359
+ "properties": {
13360
+ "key": {
13361
+ "title": "ExtensionKey",
13362
+ "type": "string",
13363
+ "minLength": 1,
13364
+ "maxLength": 32,
13365
+ "description": "Extension key."
13366
+ },
13367
+ "value": {
13368
+ "title": "ExtensionValue",
13369
+ "type": "string",
13370
+ "minLength": 1,
13371
+ "maxLength": 128,
13372
+ "description": "Extension value."
13373
+ }
13374
+ },
13375
+ "required": [
13376
+ "key",
13377
+ "value"
13378
+ ]
13379
+ },
13380
+ "minItems": 1,
13381
+ "maxItems": 16,
13382
+ "description": "Number of Extension elements."
13383
+ }
13384
+ },
13385
+ "required": [
13386
+ "extension"
13387
+ ]
13388
+ },
13389
+ "lastError": {
13390
+ "type": "object",
13391
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
13392
+ "properties": {
13393
+ "httpStatusCode": {
13394
+ "type": "integer",
13395
+ "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
13396
+ },
13397
+ "mojaloopError": {
13398
+ "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
13399
+ "type": "object",
13400
+ "properties": {
13401
+ "errorInformation": {
13402
+ "title": "ErrorInformation",
13403
+ "type": "object",
13404
+ "description": "Data model for the complex type ErrorInformation.",
13405
+ "properties": {
13406
+ "errorCode": {
13407
+ "title": "ErrorCode",
13408
+ "type": "string",
13409
+ "pattern": "^[1-9]\\d{3}$",
13410
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
13411
+ "example": "5100"
13412
+ },
13413
+ "errorDescription": {
13414
+ "title": "ErrorDescription",
13415
+ "type": "string",
13416
+ "minLength": 1,
13417
+ "maxLength": 128,
13418
+ "description": "Error description string."
13419
+ },
13420
+ "extensionList": {
13421
+ "title": "ExtensionList",
13422
+ "type": "object",
13423
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
13424
+ "properties": {
13425
+ "extension": {
13426
+ "type": "array",
13427
+ "items": {
13428
+ "title": "Extension",
13429
+ "type": "object",
13430
+ "description": "Data model for the complex type Extension.",
13431
+ "properties": {
13432
+ "key": {
13433
+ "title": "ExtensionKey",
13434
+ "type": "string",
13435
+ "minLength": 1,
13436
+ "maxLength": 32,
13437
+ "description": "Extension key."
13438
+ },
13439
+ "value": {
13440
+ "title": "ExtensionValue",
13441
+ "type": "string",
13442
+ "minLength": 1,
13443
+ "maxLength": 128,
13444
+ "description": "Extension value."
13445
+ }
13446
+ },
13447
+ "required": [
13448
+ "key",
13449
+ "value"
13450
+ ]
13451
+ },
13452
+ "minItems": 1,
13453
+ "maxItems": 16,
13454
+ "description": "Number of Extension elements."
13455
+ }
13456
+ },
13457
+ "required": [
13458
+ "extension"
13459
+ ]
13460
+ }
13461
+ },
13462
+ "required": [
13463
+ "errorCode",
13464
+ "errorDescription"
13465
+ ]
13466
+ }
13467
+ }
13468
+ }
13469
+ }
13470
+ }
13471
+ }
13472
+ },
13280
13473
  "bulkTransactionIndividualTransferResult": {
13281
13474
  "type": "object",
13282
13475
  "required": [
13283
- "homeTransactionId",
13284
- "transferId",
13285
- "to",
13286
- "amountType",
13287
- "currency",
13288
- "amount"
13476
+ "homeTransactionId"
13289
13477
  ],
13290
13478
  "properties": {
13291
13479
  "transferId": {
@@ -13676,10 +13864,15 @@
13676
13864
  "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
13677
13865
  },
13678
13866
  "quoteResponse": {
13679
- "title": "QuotesIDPutResponse",
13680
13867
  "type": "object",
13681
- "description": "The object sent in the PUT /quotes/{ID} callback.",
13682
13868
  "properties": {
13869
+ "quoteId": {
13870
+ "title": "CorrelationId",
13871
+ "type": "string",
13872
+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
13873
+ "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
13874
+ "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
13875
+ },
13683
13876
  "transferAmount": {
13684
13877
  "title": "Money",
13685
13878
  "type": "object",
@@ -14444,13 +14637,6 @@
14444
14637
  "amount"
14445
14638
  ]
14446
14639
  },
14447
- "expiration": {
14448
- "title": "DateTime",
14449
- "type": "string",
14450
- "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$",
14451
- "description": "The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are \"2016-05-24T08:38:08.699-04:00\", \"2016-05-24T08:38:08.699Z\" (where Z indicates Zulu time zone, same as UTC).",
14452
- "example": "2016-05-24T08:38:08.699-04:00"
14453
- },
14454
14640
  "geoCode": {
14455
14641
  "title": "GeoCode",
14456
14642
  "type": "object",
@@ -14532,47 +14718,118 @@
14532
14718
  "required": [
14533
14719
  "extension"
14534
14720
  ]
14721
+ },
14722
+ "lastError": {
14723
+ "description": "Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.\n",
14724
+ "type": "object",
14725
+ "properties": {
14726
+ "httpStatusCode": {
14727
+ "type": "integer",
14728
+ "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
14729
+ },
14730
+ "mojaloopError": {
14731
+ "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
14732
+ "type": "object",
14733
+ "properties": {
14734
+ "errorInformation": {
14735
+ "title": "ErrorInformation",
14736
+ "type": "object",
14737
+ "description": "Data model for the complex type ErrorInformation.",
14738
+ "properties": {
14739
+ "errorCode": {
14740
+ "title": "ErrorCode",
14741
+ "type": "string",
14742
+ "pattern": "^[1-9]\\d{3}$",
14743
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
14744
+ "example": "5100"
14745
+ },
14746
+ "errorDescription": {
14747
+ "title": "ErrorDescription",
14748
+ "type": "string",
14749
+ "minLength": 1,
14750
+ "maxLength": 128,
14751
+ "description": "Error description string."
14752
+ },
14753
+ "extensionList": {
14754
+ "title": "ExtensionList",
14755
+ "type": "object",
14756
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
14757
+ "properties": {
14758
+ "extension": {
14759
+ "type": "array",
14760
+ "items": {
14761
+ "title": "Extension",
14762
+ "type": "object",
14763
+ "description": "Data model for the complex type Extension.",
14764
+ "properties": {
14765
+ "key": {
14766
+ "title": "ExtensionKey",
14767
+ "type": "string",
14768
+ "minLength": 1,
14769
+ "maxLength": 32,
14770
+ "description": "Extension key."
14771
+ },
14772
+ "value": {
14773
+ "title": "ExtensionValue",
14774
+ "type": "string",
14775
+ "minLength": 1,
14776
+ "maxLength": 128,
14777
+ "description": "Extension value."
14778
+ }
14779
+ },
14780
+ "required": [
14781
+ "key",
14782
+ "value"
14783
+ ]
14784
+ },
14785
+ "minItems": 1,
14786
+ "maxItems": 16,
14787
+ "description": "Number of Extension elements."
14788
+ }
14789
+ },
14790
+ "required": [
14791
+ "extension"
14792
+ ]
14793
+ }
14794
+ },
14795
+ "required": [
14796
+ "errorCode",
14797
+ "errorDescription"
14798
+ ]
14799
+ }
14800
+ }
14801
+ }
14802
+ }
14535
14803
  }
14536
14804
  },
14537
14805
  "required": [
14806
+ "quoteId",
14538
14807
  "transferAmount",
14539
- "expiration",
14540
14808
  "ilpPacket",
14541
14809
  "condition"
14542
14810
  ]
14543
14811
  },
14544
14812
  "fulfil": {
14545
- "title": "TransfersIDPutResponse",
14546
14813
  "type": "object",
14547
- "description": "The object sent in the PUT /transfers/{ID} callback.",
14814
+ "required": [
14815
+ "transferId"
14816
+ ],
14548
14817
  "properties": {
14818
+ "transferId": {
14819
+ "title": "CorrelationId",
14820
+ "type": "string",
14821
+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
14822
+ "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
14823
+ "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
14824
+ },
14549
14825
  "fulfilment": {
14826
+ "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
14550
14827
  "title": "IlpFulfilment",
14551
14828
  "type": "string",
14552
14829
  "pattern": "^[A-Za-z0-9-_]{43}$",
14553
14830
  "maxLength": 48,
14554
- "description": "Fulfilment that must be attached to the transfer by the Payee.",
14555
14831
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
14556
14832
  },
14557
- "completedTimestamp": {
14558
- "title": "DateTime",
14559
- "type": "string",
14560
- "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$",
14561
- "description": "The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are \"2016-05-24T08:38:08.699-04:00\", \"2016-05-24T08:38:08.699Z\" (where Z indicates Zulu time zone, same as UTC).",
14562
- "example": "2016-05-24T08:38:08.699-04:00"
14563
- },
14564
- "transferState": {
14565
- "title": "TransferState",
14566
- "type": "string",
14567
- "enum": [
14568
- "RECEIVED",
14569
- "RESERVED",
14570
- "COMMITTED",
14571
- "ABORTED"
14572
- ],
14573
- "description": "Below are the allowed values for the enumeration.\n- RECEIVED - Next ledger has received the transfer.\n- RESERVED - Next ledger has reserved the transfer.\n- COMMITTED - Next ledger has successfully performed the transfer.\n- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.",
14574
- "example": "RESERVED"
14575
- },
14576
14833
  "extensionList": {
14577
14834
  "title": "ExtensionList",
14578
14835
  "type": "object",
@@ -14613,11 +14870,90 @@
14613
14870
  "required": [
14614
14871
  "extension"
14615
14872
  ]
14873
+ },
14874
+ "lastError": {
14875
+ "type": "object",
14876
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
14877
+ "properties": {
14878
+ "httpStatusCode": {
14879
+ "type": "integer",
14880
+ "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
14881
+ },
14882
+ "mojaloopError": {
14883
+ "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
14884
+ "type": "object",
14885
+ "properties": {
14886
+ "errorInformation": {
14887
+ "title": "ErrorInformation",
14888
+ "type": "object",
14889
+ "description": "Data model for the complex type ErrorInformation.",
14890
+ "properties": {
14891
+ "errorCode": {
14892
+ "title": "ErrorCode",
14893
+ "type": "string",
14894
+ "pattern": "^[1-9]\\d{3}$",
14895
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
14896
+ "example": "5100"
14897
+ },
14898
+ "errorDescription": {
14899
+ "title": "ErrorDescription",
14900
+ "type": "string",
14901
+ "minLength": 1,
14902
+ "maxLength": 128,
14903
+ "description": "Error description string."
14904
+ },
14905
+ "extensionList": {
14906
+ "title": "ExtensionList",
14907
+ "type": "object",
14908
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
14909
+ "properties": {
14910
+ "extension": {
14911
+ "type": "array",
14912
+ "items": {
14913
+ "title": "Extension",
14914
+ "type": "object",
14915
+ "description": "Data model for the complex type Extension.",
14916
+ "properties": {
14917
+ "key": {
14918
+ "title": "ExtensionKey",
14919
+ "type": "string",
14920
+ "minLength": 1,
14921
+ "maxLength": 32,
14922
+ "description": "Extension key."
14923
+ },
14924
+ "value": {
14925
+ "title": "ExtensionValue",
14926
+ "type": "string",
14927
+ "minLength": 1,
14928
+ "maxLength": 128,
14929
+ "description": "Extension value."
14930
+ }
14931
+ },
14932
+ "required": [
14933
+ "key",
14934
+ "value"
14935
+ ]
14936
+ },
14937
+ "minItems": 1,
14938
+ "maxItems": 16,
14939
+ "description": "Number of Extension elements."
14940
+ }
14941
+ },
14942
+ "required": [
14943
+ "extension"
14944
+ ]
14945
+ }
14946
+ },
14947
+ "required": [
14948
+ "errorCode",
14949
+ "errorDescription"
14950
+ ]
14951
+ }
14952
+ }
14953
+ }
14954
+ }
14616
14955
  }
14617
- },
14618
- "required": [
14619
- "transferState"
14620
- ]
14956
+ }
14621
14957
  },
14622
14958
  "quoteExtensions": {
14623
14959
  "title": "ExtensionList",
@@ -15080,12 +15416,7 @@
15080
15416
  "items": {
15081
15417
  "type": "object",
15082
15418
  "required": [
15083
- "homeTransactionId",
15084
- "transferId",
15085
- "to",
15086
- "amountType",
15087
- "currency",
15088
- "amount"
15419
+ "homeTransactionId"
15089
15420
  ],
15090
15421
  "properties": {
15091
15422
  "transferId": {
@@ -15476,10 +15807,15 @@
15476
15807
  "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
15477
15808
  },
15478
15809
  "quoteResponse": {
15479
- "title": "QuotesIDPutResponse",
15480
15810
  "type": "object",
15481
- "description": "The object sent in the PUT /quotes/{ID} callback.",
15482
15811
  "properties": {
15812
+ "quoteId": {
15813
+ "title": "CorrelationId",
15814
+ "type": "string",
15815
+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
15816
+ "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
15817
+ "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
15818
+ },
15483
15819
  "transferAmount": {
15484
15820
  "title": "Money",
15485
15821
  "type": "object",
@@ -16244,13 +16580,6 @@
16244
16580
  "amount"
16245
16581
  ]
16246
16582
  },
16247
- "expiration": {
16248
- "title": "DateTime",
16249
- "type": "string",
16250
- "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$",
16251
- "description": "The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are \"2016-05-24T08:38:08.699-04:00\", \"2016-05-24T08:38:08.699Z\" (where Z indicates Zulu time zone, same as UTC).",
16252
- "example": "2016-05-24T08:38:08.699-04:00"
16253
- },
16254
16583
  "geoCode": {
16255
16584
  "title": "GeoCode",
16256
16585
  "type": "object",
@@ -16332,47 +16661,118 @@
16332
16661
  "required": [
16333
16662
  "extension"
16334
16663
  ]
16664
+ },
16665
+ "lastError": {
16666
+ "description": "Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.\n",
16667
+ "type": "object",
16668
+ "properties": {
16669
+ "httpStatusCode": {
16670
+ "type": "integer",
16671
+ "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
16672
+ },
16673
+ "mojaloopError": {
16674
+ "description": "If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
16675
+ "type": "object",
16676
+ "properties": {
16677
+ "errorInformation": {
16678
+ "title": "ErrorInformation",
16679
+ "type": "object",
16680
+ "description": "Data model for the complex type ErrorInformation.",
16681
+ "properties": {
16682
+ "errorCode": {
16683
+ "title": "ErrorCode",
16684
+ "type": "string",
16685
+ "pattern": "^[1-9]\\d{3}$",
16686
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
16687
+ "example": "5100"
16688
+ },
16689
+ "errorDescription": {
16690
+ "title": "ErrorDescription",
16691
+ "type": "string",
16692
+ "minLength": 1,
16693
+ "maxLength": 128,
16694
+ "description": "Error description string."
16695
+ },
16696
+ "extensionList": {
16697
+ "title": "ExtensionList",
16698
+ "type": "object",
16699
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
16700
+ "properties": {
16701
+ "extension": {
16702
+ "type": "array",
16703
+ "items": {
16704
+ "title": "Extension",
16705
+ "type": "object",
16706
+ "description": "Data model for the complex type Extension.",
16707
+ "properties": {
16708
+ "key": {
16709
+ "title": "ExtensionKey",
16710
+ "type": "string",
16711
+ "minLength": 1,
16712
+ "maxLength": 32,
16713
+ "description": "Extension key."
16714
+ },
16715
+ "value": {
16716
+ "title": "ExtensionValue",
16717
+ "type": "string",
16718
+ "minLength": 1,
16719
+ "maxLength": 128,
16720
+ "description": "Extension value."
16721
+ }
16722
+ },
16723
+ "required": [
16724
+ "key",
16725
+ "value"
16726
+ ]
16727
+ },
16728
+ "minItems": 1,
16729
+ "maxItems": 16,
16730
+ "description": "Number of Extension elements."
16731
+ }
16732
+ },
16733
+ "required": [
16734
+ "extension"
16735
+ ]
16736
+ }
16737
+ },
16738
+ "required": [
16739
+ "errorCode",
16740
+ "errorDescription"
16741
+ ]
16742
+ }
16743
+ }
16744
+ }
16745
+ }
16335
16746
  }
16336
16747
  },
16337
16748
  "required": [
16749
+ "quoteId",
16338
16750
  "transferAmount",
16339
- "expiration",
16340
16751
  "ilpPacket",
16341
16752
  "condition"
16342
16753
  ]
16343
16754
  },
16344
16755
  "fulfil": {
16345
- "title": "TransfersIDPutResponse",
16346
16756
  "type": "object",
16347
- "description": "The object sent in the PUT /transfers/{ID} callback.",
16757
+ "required": [
16758
+ "transferId"
16759
+ ],
16348
16760
  "properties": {
16761
+ "transferId": {
16762
+ "title": "CorrelationId",
16763
+ "type": "string",
16764
+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
16765
+ "description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
16766
+ "example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
16767
+ },
16349
16768
  "fulfilment": {
16769
+ "description": "Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.\n",
16350
16770
  "title": "IlpFulfilment",
16351
16771
  "type": "string",
16352
16772
  "pattern": "^[A-Za-z0-9-_]{43}$",
16353
16773
  "maxLength": 48,
16354
- "description": "Fulfilment that must be attached to the transfer by the Payee.",
16355
16774
  "example": "WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8"
16356
16775
  },
16357
- "completedTimestamp": {
16358
- "title": "DateTime",
16359
- "type": "string",
16360
- "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$",
16361
- "description": "The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are \"2016-05-24T08:38:08.699-04:00\", \"2016-05-24T08:38:08.699Z\" (where Z indicates Zulu time zone, same as UTC).",
16362
- "example": "2016-05-24T08:38:08.699-04:00"
16363
- },
16364
- "transferState": {
16365
- "title": "TransferState",
16366
- "type": "string",
16367
- "enum": [
16368
- "RECEIVED",
16369
- "RESERVED",
16370
- "COMMITTED",
16371
- "ABORTED"
16372
- ],
16373
- "description": "Below are the allowed values for the enumeration.\n- RECEIVED - Next ledger has received the transfer.\n- RESERVED - Next ledger has reserved the transfer.\n- COMMITTED - Next ledger has successfully performed the transfer.\n- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.",
16374
- "example": "RESERVED"
16375
- },
16376
16776
  "extensionList": {
16377
16777
  "title": "ExtensionList",
16378
16778
  "type": "object",
@@ -16413,11 +16813,90 @@
16413
16813
  "required": [
16414
16814
  "extension"
16415
16815
  ]
16816
+ },
16817
+ "lastError": {
16818
+ "type": "object",
16819
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
16820
+ "properties": {
16821
+ "httpStatusCode": {
16822
+ "type": "integer",
16823
+ "description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
16824
+ },
16825
+ "mojaloopError": {
16826
+ "description": "If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.",
16827
+ "type": "object",
16828
+ "properties": {
16829
+ "errorInformation": {
16830
+ "title": "ErrorInformation",
16831
+ "type": "object",
16832
+ "description": "Data model for the complex type ErrorInformation.",
16833
+ "properties": {
16834
+ "errorCode": {
16835
+ "title": "ErrorCode",
16836
+ "type": "string",
16837
+ "pattern": "^[1-9]\\d{3}$",
16838
+ "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
16839
+ "example": "5100"
16840
+ },
16841
+ "errorDescription": {
16842
+ "title": "ErrorDescription",
16843
+ "type": "string",
16844
+ "minLength": 1,
16845
+ "maxLength": 128,
16846
+ "description": "Error description string."
16847
+ },
16848
+ "extensionList": {
16849
+ "title": "ExtensionList",
16850
+ "type": "object",
16851
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
16852
+ "properties": {
16853
+ "extension": {
16854
+ "type": "array",
16855
+ "items": {
16856
+ "title": "Extension",
16857
+ "type": "object",
16858
+ "description": "Data model for the complex type Extension.",
16859
+ "properties": {
16860
+ "key": {
16861
+ "title": "ExtensionKey",
16862
+ "type": "string",
16863
+ "minLength": 1,
16864
+ "maxLength": 32,
16865
+ "description": "Extension key."
16866
+ },
16867
+ "value": {
16868
+ "title": "ExtensionValue",
16869
+ "type": "string",
16870
+ "minLength": 1,
16871
+ "maxLength": 128,
16872
+ "description": "Extension value."
16873
+ }
16874
+ },
16875
+ "required": [
16876
+ "key",
16877
+ "value"
16878
+ ]
16879
+ },
16880
+ "minItems": 1,
16881
+ "maxItems": 16,
16882
+ "description": "Number of Extension elements."
16883
+ }
16884
+ },
16885
+ "required": [
16886
+ "extension"
16887
+ ]
16888
+ }
16889
+ },
16890
+ "required": [
16891
+ "errorCode",
16892
+ "errorDescription"
16893
+ ]
16894
+ }
16895
+ }
16896
+ }
16897
+ }
16416
16898
  }
16417
- },
16418
- "required": [
16419
- "transferState"
16420
- ]
16899
+ }
16421
16900
  },
16422
16901
  "quoteExtensions": {
16423
16902
  "title": "ExtensionList",