@mojaloop/api-snippets 17.3.0-snapshot.0 → 17.3.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 (248) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +0 -12
  3. package/audit-ci.jsonc +1 -1
  4. package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +205 -805
  5. package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +2432 -2447
  6. package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +3149 -3163
  7. package/docs/index.html +0 -4
  8. package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +103 -346
  9. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +153 -478
  10. package/docs/thirdparty-openapi3-snippets.yaml +296 -886
  11. package/fspiop/v1_0/openapi3/components/schemas/PartiesTypeIDPutResponse.yaml +1 -0
  12. package/fspiop/v1_1/openapi3/openapi.yaml +10 -2
  13. package/fspiop/v2_0/openapi3/openapi.yaml +11 -1
  14. package/lib/fspiop/v1_0/openapi.d.ts +1 -0
  15. package/lib/fspiop/v1_1/openapi.d.ts +524 -542
  16. package/lib/fspiop/v2_0/openapi.d.ts +685 -703
  17. package/lib/scripts/openapi-refactor.d.ts +29 -0
  18. package/lib/scripts/openapi-refactor.js +70 -0
  19. package/lib/scripts/openapi-refactor.js.map +1 -0
  20. package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +7 -7
  21. package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +1 -1
  22. package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +12 -12
  23. package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +7 -1
  24. package/package.json +24 -30
  25. package/sdk-scheme-adapter/v2_0_0/components/schemas/getPartiesResponse.yaml +1 -0
  26. package/sdk-scheme-adapter/v2_0_0/components/schemas/partiesByIdResponse.yaml +1 -0
  27. package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayResponse.yaml +5 -0
  28. package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayTransferResponse.yaml +5 -0
  29. package/sdk-scheme-adapter/v2_0_0/components/schemas/simpleQuotesPostRequest.yaml +1 -0
  30. package/sdk-scheme-adapter/v2_0_0/components/schemas/transferError.yaml +2 -3
  31. package/sdk-scheme-adapter/v2_0_0/components/schemas/transferResponse.yaml +5 -0
  32. package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +0 -2837
  33. package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +0 -3451
  34. package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +0 -26898
  35. package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +0 -1476
  36. package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.js +0 -7
  37. package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.js.map +0 -1
  38. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.d.ts +0 -8814
  39. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js +0 -140
  40. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js.map +0 -1
  41. package/lib/sdk-scheme-adapter/v2_1_0/backend/types.d.ts +0 -133
  42. package/lib/sdk-scheme-adapter/v2_1_0/backend/types.js +0 -4
  43. package/lib/sdk-scheme-adapter/v2_1_0/backend/types.js.map +0 -1
  44. package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +0 -38718
  45. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +0 -1897
  46. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.js +0 -7
  47. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.js.map +0 -1
  48. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +0 -15536
  49. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js +0 -149
  50. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js.map +0 -1
  51. package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.d.ts +0 -142
  52. package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.js +0 -4
  53. package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.js.map +0 -1
  54. package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +0 -1494
  55. package/sdk-scheme-adapter/v2_1_0/backend/paths/fxQuotes.yaml +0 -26
  56. package/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfers.yaml +0 -25
  57. package/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfersById.yaml +0 -21
  58. package/sdk-scheme-adapter/v2_1_0/components/parameters/ID.yaml +0 -6
  59. package/sdk-scheme-adapter/v2_1_0/components/parameters/SubId.yaml +0 -8
  60. package/sdk-scheme-adapter/v2_1_0/components/parameters/Type.yaml +0 -6
  61. package/sdk-scheme-adapter/v2_1_0/components/parameters/bulkQuoteId.yaml +0 -8
  62. package/sdk-scheme-adapter/v2_1_0/components/parameters/bulkTransactionId.yaml +0 -8
  63. package/sdk-scheme-adapter/v2_1_0/components/parameters/bulkTransferId.yaml +0 -8
  64. package/sdk-scheme-adapter/v2_1_0/components/parameters/transactionRequestId.yaml +0 -8
  65. package/sdk-scheme-adapter/v2_1_0/components/parameters/transferId.yaml +0 -8
  66. package/sdk-scheme-adapter/v2_1_0/components/responses/200.yaml +0 -1
  67. package/sdk-scheme-adapter/v2_1_0/components/responses/400.yaml +0 -5
  68. package/sdk-scheme-adapter/v2_1_0/components/responses/404.yaml +0 -5
  69. package/sdk-scheme-adapter/v2_1_0/components/responses/500.yaml +0 -5
  70. package/sdk-scheme-adapter/v2_1_0/components/responses/accountsCreationCompleted.yaml +0 -5
  71. package/sdk-scheme-adapter/v2_1_0/components/responses/accountsCreationError.yaml +0 -5
  72. package/sdk-scheme-adapter/v2_1_0/components/responses/accountsCreationTimeout.yaml +0 -5
  73. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteBadRequest.yaml +0 -5
  74. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteServerError.yaml +0 -5
  75. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteSuccess.yaml +0 -5
  76. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteTimeout.yaml +0 -5
  77. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransactionAccepted.yaml +0 -1
  78. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransactionBadRequest.yaml +0 -5
  79. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransactionPutBadRequest.yaml +0 -7
  80. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransferBadRequest.yaml +0 -5
  81. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransferStatusResponse.yaml +0 -16
  82. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransferSuccess.yaml +0 -5
  83. package/sdk-scheme-adapter/v2_1_0/components/responses/errorResponse.yaml +0 -5
  84. package/sdk-scheme-adapter/v2_1_0/components/responses/partiesByIdError404.yaml +0 -8
  85. package/sdk-scheme-adapter/v2_1_0/components/responses/partiesByIdSuccess.yaml +0 -5
  86. package/sdk-scheme-adapter/v2_1_0/components/responses/quotesPostSuccess.yaml +0 -5
  87. package/sdk-scheme-adapter/v2_1_0/components/responses/quotesServerError.yaml +0 -5
  88. package/sdk-scheme-adapter/v2_1_0/components/responses/requestToPaySuccess.yaml +0 -5
  89. package/sdk-scheme-adapter/v2_1_0/components/responses/requestToPayTransferBadRequest.yaml +0 -5
  90. package/sdk-scheme-adapter/v2_1_0/components/responses/requestToPayTransferSuccess.yaml +0 -5
  91. package/sdk-scheme-adapter/v2_1_0/components/responses/servicesFXPSucess.yaml +0 -5
  92. package/sdk-scheme-adapter/v2_1_0/components/responses/simpleTransfersPostSuccess.yaml +0 -5
  93. package/sdk-scheme-adapter/v2_1_0/components/responses/simpleTransfersServerError.yaml +0 -5
  94. package/sdk-scheme-adapter/v2_1_0/components/responses/transferBadRequest.yaml +0 -5
  95. package/sdk-scheme-adapter/v2_1_0/components/responses/transferServerError.yaml +0 -5
  96. package/sdk-scheme-adapter/v2_1_0/components/responses/transferSuccess.yaml +0 -5
  97. package/sdk-scheme-adapter/v2_1_0/components/responses/transferTimeout.yaml +0 -5
  98. package/sdk-scheme-adapter/v2_1_0/components/schemas/Amount.yaml +0 -11
  99. package/sdk-scheme-adapter/v2_1_0/components/schemas/AmountType.yaml +0 -14
  100. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthenticationInfo.yaml +0 -11
  101. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthenticationType.yaml +0 -12
  102. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthenticationValue.yaml +0 -44
  103. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthorizationIDPutResponse.yaml +0 -10
  104. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthorizationResponseType.yaml +0 -12
  105. package/sdk-scheme-adapter/v2_1_0/components/schemas/BalanceOfPayments.yaml +0 -9
  106. package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml +0 -10
  107. package/sdk-scheme-adapter/v2_1_0/components/schemas/Currency.yaml +0 -174
  108. package/sdk-scheme-adapter/v2_1_0/components/schemas/DateOfBirth.yaml +0 -6
  109. package/sdk-scheme-adapter/v2_1_0/components/schemas/DateTime.yaml +0 -14
  110. package/sdk-scheme-adapter/v2_1_0/components/schemas/ErrorCode.yaml +0 -11
  111. package/sdk-scheme-adapter/v2_1_0/components/schemas/ErrorDescription.yaml +0 -5
  112. package/sdk-scheme-adapter/v2_1_0/components/schemas/ErrorInformation.yaml +0 -13
  113. package/sdk-scheme-adapter/v2_1_0/components/schemas/Extension.yaml +0 -11
  114. package/sdk-scheme-adapter/v2_1_0/components/schemas/ExtensionKey.yaml +0 -5
  115. package/sdk-scheme-adapter/v2_1_0/components/schemas/ExtensionList.yaml +0 -15
  116. package/sdk-scheme-adapter/v2_1_0/components/schemas/ExtensionValue.yaml +0 -5
  117. package/sdk-scheme-adapter/v2_1_0/components/schemas/FirstName.yaml +0 -9
  118. package/sdk-scheme-adapter/v2_1_0/components/schemas/FspId.yaml +0 -5
  119. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostBackendRequest.yaml +0 -16
  120. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostBackendResponse.yaml +0 -14
  121. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostOutboundRequest.yaml +0 -19
  122. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostOutboundResponse.yaml +0 -18
  123. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostBackendRequest.yaml +0 -28
  124. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostBackendResponse.yaml +0 -17
  125. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostOutboundRequest.yaml +0 -28
  126. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostOutboundResponse.yaml +0 -17
  127. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPutBackendRequest.yaml +0 -17
  128. package/sdk-scheme-adapter/v2_1_0/components/schemas/GeoCode.yaml +0 -13
  129. package/sdk-scheme-adapter/v2_1_0/components/schemas/IlpCondition.yaml +0 -5
  130. package/sdk-scheme-adapter/v2_1_0/components/schemas/IlpFulfilment.yaml +0 -6
  131. package/sdk-scheme-adapter/v2_1_0/components/schemas/IlpPacket.yaml +0 -8
  132. package/sdk-scheme-adapter/v2_1_0/components/schemas/LastName.yaml +0 -9
  133. package/sdk-scheme-adapter/v2_1_0/components/schemas/Latitude.yaml +0 -7
  134. package/sdk-scheme-adapter/v2_1_0/components/schemas/Longitude.yaml +0 -8
  135. package/sdk-scheme-adapter/v2_1_0/components/schemas/MerchantClassificationCode.yaml +0 -7
  136. package/sdk-scheme-adapter/v2_1_0/components/schemas/MiddleName.yaml +0 -9
  137. package/sdk-scheme-adapter/v2_1_0/components/schemas/Money.yaml +0 -11
  138. package/sdk-scheme-adapter/v2_1_0/components/schemas/Name.yaml +0 -17
  139. package/sdk-scheme-adapter/v2_1_0/components/schemas/Note.yaml +0 -6
  140. package/sdk-scheme-adapter/v2_1_0/components/schemas/Party.yaml +0 -21
  141. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyComplexName.yaml +0 -10
  142. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdInfo.yaml +0 -19
  143. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdType.yaml +0 -54
  144. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdentifier.yaml +0 -6
  145. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyName.yaml +0 -5
  146. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyPersonalInfo.yaml +0 -8
  147. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartySubIdOrType.yaml +0 -7
  148. package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesIDPutResponse.yaml +0 -27
  149. package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesPostRequest.yaml +0 -53
  150. package/sdk-scheme-adapter/v2_1_0/components/schemas/Refund.yaml +0 -10
  151. package/sdk-scheme-adapter/v2_1_0/components/schemas/RefundReason.yaml +0 -6
  152. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionInitiator.yaml +0 -16
  153. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionInitiatorType.yaml +0 -14
  154. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionRequestResponse.yaml +0 -20
  155. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionRequestState.yaml +0 -14
  156. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionScenario.yaml +0 -32
  157. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionSubScenario.yaml +0 -5
  158. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionType.yaml +0 -20
  159. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransferState.yaml +0 -19
  160. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersIDPutResponse.yaml +0 -14
  161. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersPostRequest.yaml +0 -28
  162. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountCreationStatus.yaml +0 -15
  163. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountsCreationState.yaml +0 -4
  164. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountsRequest.yaml +0 -16
  165. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountsResponse.yaml +0 -23
  166. package/sdk-scheme-adapter/v2_1_0/components/schemas/async2SyncCurrentState.yaml +0 -5
  167. package/sdk-scheme-adapter/v2_1_0/components/schemas/autoAcceptPartyOption.yaml +0 -9
  168. package/sdk-scheme-adapter/v2_1_0/components/schemas/autoAcceptQuote.yaml +0 -14
  169. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkPerTransferFeeLimit.yaml +0 -9
  170. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteErrorResponse.yaml +0 -8
  171. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteRequest.yaml +0 -24
  172. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteResponse.yaml +0 -26
  173. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteStatus.yaml +0 -4
  174. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteStatusResponse.yaml +0 -16
  175. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionAcceptPartyErrorResponse.yaml +0 -10
  176. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionAcceptQuoteErrorResponse.yaml +0 -10
  177. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionContinuationAcceptParty.yaml +0 -17
  178. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionContinuationAcceptQuote.yaml +0 -13
  179. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransfer.yaml +0 -34
  180. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransferAccept.yaml +0 -7
  181. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransferResult.yaml +0 -38
  182. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionOptions.yaml +0 -35
  183. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionRequest.yaml +0 -27
  184. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionResponse.yaml +0 -27
  185. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionStatus.yaml +0 -6
  186. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferErrorResponse.yaml +0 -8
  187. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferRequest.yaml +0 -28
  188. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferResponse.yaml +0 -29
  189. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferStatus.yaml +0 -4
  190. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorAccountsResponse.yaml +0 -8
  191. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorQuotesResponse.yaml +0 -3
  192. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorResponse.yaml +0 -10
  193. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorSimpleTransfersResponse.yaml +0 -3
  194. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorTransferResponse.yaml +0 -8
  195. package/sdk-scheme-adapter/v2_1_0/components/schemas/extensionListEmptiable.yaml +0 -5
  196. package/sdk-scheme-adapter/v2_1_0/components/schemas/getPartiesResponse.yaml +0 -11
  197. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuote.yaml +0 -29
  198. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuoteResult.yaml +0 -25
  199. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransfer.yaml +0 -34
  200. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferFulfilment.yaml +0 -9
  201. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferResult.yaml +0 -14
  202. package/sdk-scheme-adapter/v2_1_0/components/schemas/mojaloopError.yaml +0 -4
  203. package/sdk-scheme-adapter/v2_1_0/components/schemas/partiesByIdResponse.yaml +0 -18
  204. package/sdk-scheme-adapter/v2_1_0/components/schemas/partyError.yaml +0 -12
  205. package/sdk-scheme-adapter/v2_1_0/components/schemas/quoteError.yaml +0 -12
  206. package/sdk-scheme-adapter/v2_1_0/components/schemas/quotesPostResponse.yaml +0 -48
  207. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayRequest.yaml +0 -32
  208. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayResponse.yaml +0 -35
  209. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayStatus.yaml +0 -5
  210. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayTransferRequest.yaml +0 -42
  211. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayTransferResponse.yaml +0 -72
  212. package/sdk-scheme-adapter/v2_1_0/components/schemas/simpleQuotesPostRequest.yaml +0 -10
  213. package/sdk-scheme-adapter/v2_1_0/components/schemas/simpleTransfersPostRequest.yaml +0 -10
  214. package/sdk-scheme-adapter/v2_1_0/components/schemas/simpleTransfersPostResponse.yaml +0 -17
  215. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptConversion.yaml +0 -9
  216. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptOTP.yaml +0 -9
  217. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptParty.yaml +0 -9
  218. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptQuote.yaml +0 -9
  219. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferError.yaml +0 -12
  220. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferParty.yaml +0 -38
  221. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferRequest.yaml +0 -41
  222. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferResponse.yaml +0 -93
  223. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferStatus.yaml +0 -7
  224. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferStatusResponse.yaml +0 -19
  225. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferTransactionType.yaml +0 -5
  226. package/sdk-scheme-adapter/v2_1_0/outbound/openapi.yaml +0 -66
  227. package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts.yaml +0 -26
  228. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkQuotes.yaml +0 -23
  229. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkQuotes_bulkQuoteId.yaml +0 -24
  230. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkTransactions.yaml +0 -21
  231. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkTransactions_bulkTransactionId.yaml +0 -33
  232. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkTransfers.yaml +0 -21
  233. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkTransfers_bulkTransferId.yaml +0 -24
  234. package/sdk-scheme-adapter/v2_1_0/outbound/paths/fxQuotes.yaml +0 -26
  235. package/sdk-scheme-adapter/v2_1_0/outbound/paths/fxTransfers.yaml +0 -25
  236. package/sdk-scheme-adapter/v2_1_0/outbound/paths/parties_Type_ID.yaml +0 -18
  237. package/sdk-scheme-adapter/v2_1_0/outbound/paths/parties_Type_ID_SubId.yaml +0 -19
  238. package/sdk-scheme-adapter/v2_1_0/outbound/paths/quotes.yaml +0 -18
  239. package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPay.yaml +0 -22
  240. package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPayTransfer.yaml +0 -57
  241. package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPayTransfer_transactionRequestId.yaml +0 -34
  242. package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPay_transactionRequestId.yaml +0 -29
  243. package/sdk-scheme-adapter/v2_1_0/outbound/paths/services_FXP.yaml +0 -15
  244. package/sdk-scheme-adapter/v2_1_0/outbound/paths/services_FXP_SourceCurrency_TargetCurrency.yaml +0 -18
  245. package/sdk-scheme-adapter/v2_1_0/outbound/paths/simpleTransfers.yaml +0 -18
  246. package/sdk-scheme-adapter/v2_1_0/outbound/paths/transfers.yaml +0 -55
  247. package/sdk-scheme-adapter/v2_1_0/outbound/paths/transfers_transferId.yaml +0 -59
  248. package/sdk-scheme-adapter/v2_1_0/outbound/paths.yaml +0 -12
@@ -3,10 +3,6 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
  export interface paths {
6
- "/interface": {
7
- /** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
8
- post: operations["test"];
9
- };
10
6
  "/participants/{Type}/{ID}": {
11
7
  /**
12
8
  * Look up participant information
@@ -499,53 +495,139 @@ export interface paths {
499
495
  export type webhooks = Record<string, never>;
500
496
  export interface components {
501
497
  schemas: {
498
+ /**
499
+ * Amount
500
+ * @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.
501
+ * @example 123.45
502
+ */
503
+ Amount: string;
504
+ /**
505
+ * AmountType
506
+ * @description Below are the allowed values for the enumeration AmountType.
507
+ * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
508
+ * - RECEIVE - Amount the Payer would like the Payee to receive, that is, the amount that should be sent to the receiver exclusive of any fees.
509
+ * @example RECEIVE
510
+ * @enum {string}
511
+ */
512
+ AmountType: "SEND" | "RECEIVE";
513
+ /**
514
+ * AuthenticationInfo
515
+ * @description Data model for the complex type AuthenticationInfo.
516
+ */
517
+ AuthenticationInfo: {
518
+ authentication: components["schemas"]["AuthenticationType"];
519
+ authenticationValue: components["schemas"]["AuthenticationValue"];
520
+ };
521
+ /**
522
+ * AuthenticationType
523
+ * @description Below are the allowed values for the enumeration AuthenticationType.
524
+ * - OTP - One-time password generated by the Payer FSP.
525
+ * - QRCODE - QR code used as One Time Password.
526
+ * - U2F - U2F is a new addition isolated to Thirdparty stream.
527
+ * @example OTP
528
+ * @enum {string}
529
+ */
530
+ AuthenticationType: "OTP" | "QRCODE" | "U2F";
531
+ /**
532
+ * AuthenticationValue
533
+ * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
534
+ */
535
+ AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"];
536
+ /**
537
+ * AuthorizationResponse
538
+ * @description Below are the allowed values for the enumeration.
539
+ * - ENTERED - Consumer entered the authentication value.
540
+ * - REJECTED - Consumer rejected the transaction.
541
+ * - RESEND - Consumer requested to resend the authentication value.
542
+ * @example ENTERED
543
+ * @enum {string}
544
+ */
545
+ AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND";
546
+ /**
547
+ * AuthorizationsIDPutResponse
548
+ * @description The object sent in the PUT /authorizations/{ID} callback.
549
+ */
550
+ AuthorizationsIDPutResponse: {
551
+ authenticationInfo?: components["schemas"]["AuthenticationInfo"];
552
+ responseType: components["schemas"]["AuthorizationResponse"];
553
+ };
554
+ /**
555
+ * BalanceOfPayments
556
+ * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed.
557
+ * @example 123
558
+ */
559
+ BalanceOfPayments: string;
502
560
  /** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */
503
561
  BinaryString: string;
504
562
  /** @description The API data type BinaryString32 is a fixed size version of the API data type BinaryString, where the raw underlying data is always of 32 bytes. The data type BinaryString32 should not use a padding character as the size of the underlying data is fixed. */
505
563
  BinaryString32: string;
506
564
  /**
507
- * Date
508
- * @description The API data type Date is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. This format, as specified in ISO 8601, contains a date only. A more readable version of the format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”.
509
- */
510
- Date: string;
511
- /**
512
- * Integer
513
- * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits.
565
+ * BulkQuotesIDPutResponse
566
+ * @description The object sent in the PUT /bulkQuotes/{ID} callback.
514
567
  */
515
- Integer: string;
568
+ BulkQuotesIDPutResponse: {
569
+ /** @description Fees for each individual transaction, if any of them are charged per transaction. */
570
+ individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][];
571
+ expiration: components["schemas"]["DateTime"];
572
+ extensionList?: components["schemas"]["ExtensionList"];
573
+ };
516
574
  /**
517
- * Name
518
- * @description The API data type Name is a JSON String, restricted by a regular expression to avoid characters which are generally not used in a name.
519
- *
520
- * Regular Expression - The regular expression for restricting the Name type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a string consisting of whitespace only, all Unicode characters are allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,) and space characters ( ).
521
- *
522
- * **Note:** In some programming languages, Unicode support must be specifically enabled. For example, if Java is used, the flag UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
575
+ * BulkQuotesPostRequest
576
+ * @description The object sent in the POST /bulkQuotes request.
523
577
  */
524
- Name: string;
578
+ BulkQuotesPostRequest: {
579
+ bulkQuoteId: components["schemas"]["CorrelationId"];
580
+ payer: components["schemas"]["Party"];
581
+ geoCode?: components["schemas"]["GeoCode"];
582
+ expiration?: components["schemas"]["DateTime"];
583
+ /** @description List of quotes elements. */
584
+ individualQuotes: components["schemas"]["IndividualQuote"][];
585
+ extensionList?: components["schemas"]["ExtensionList"];
586
+ };
525
587
  /**
526
- * PersonalIdentifierType
588
+ * BulkTransactionState
527
589
  * @description Below are the allowed values for the enumeration.
528
- * - PASSPORT - A passport number is used as reference to a Party.
529
- * - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party.
530
- * - DRIVING_LICENSE - A driving license is used as reference to a Party.
531
- * - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party.
532
- * - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party.
533
- * - EMPLOYER_ID - A tax identification number is used as reference to a Party.
534
- * - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
535
- * - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
536
- * - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
537
- * - HEALTH_CARD - A health card number is used as reference to a Party.
538
- * - VOTERS_ID - A voter’s identification number is used as reference to a Party.
539
- * - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
540
- * - OTHER_ID - Any other type of identification type number is used as reference to a Party.
590
+ * - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
591
+ * - PENDING - Payee FSP has validated the bulk transfer.
592
+ * - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
593
+ * - PROCESSING - Payee FSP has started to transfer fund to the Payees.
594
+ * - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
595
+ * - REJECTED - Payee FSP has rejected to process the bulk transfer.
596
+ * @example RECEIVED
541
597
  * @enum {string}
542
598
  */
543
- PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID";
599
+ BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED";
544
600
  /**
545
- * TokenCode
546
- * @description The API data type TokenCode is a JSON String between 4 and 32 characters, consisting of digits or upper- or lowercase characters from a to z.
601
+ * BulkTransfersIDPutResponse
602
+ * @description The object sent in the PUT /bulkTransfers/{ID} callback.
547
603
  */
548
- TokenCode: string;
604
+ BulkTransfersIDPutResponse: {
605
+ completedTimestamp?: components["schemas"]["DateTime"];
606
+ /** @description List of IndividualTransferResult elements. */
607
+ individualTransferResults?: components["schemas"]["IndividualTransferResult"][];
608
+ bulkTransferState: components["schemas"]["BulkTransferState"];
609
+ extensionList?: components["schemas"]["ExtensionList"];
610
+ };
611
+ /**
612
+ * BulkTransfersPostRequest
613
+ * @description The object sent in the POST /bulkTransfers request.
614
+ */
615
+ BulkTransfersPostRequest: {
616
+ bulkTransferId: components["schemas"]["CorrelationId"];
617
+ bulkQuoteId: components["schemas"]["CorrelationId"];
618
+ payerFsp: components["schemas"]["FspId"];
619
+ payeeFsp: components["schemas"]["FspId"];
620
+ /** @description List of IndividualTransfer elements. */
621
+ individualTransfers: components["schemas"]["IndividualTransfer"][];
622
+ expiration: components["schemas"]["DateTime"];
623
+ extensionList?: components["schemas"]["ExtensionList"];
624
+ };
625
+ /**
626
+ * Code
627
+ * @description Any code/token returned by the Payee FSP (TokenCode Type).
628
+ * @example Test-Code
629
+ */
630
+ Code: string;
549
631
  /**
550
632
  * CorrelationId
551
633
  * @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 (‘-‘).
@@ -553,45 +635,62 @@ export interface components {
553
635
  */
554
636
  CorrelationId: string;
555
637
  /**
556
- * PartyIdType
557
- * @description Below are the allowed values for the enumeration.
558
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.
559
- * - EMAIL - An email is used as reference to a participant. The format of the email should be according to the informational [RFC 3696](https://tools.ietf.org/html/rfc3696).
560
- * - PERSONAL_ID - A personal identifier is used as reference to a participant. Examples of personal identification are passport number, birth certificate number, and national registration number. The identifier number is added in the PartyIdentifier element. The personal identifier type is added in the PartySubIdOrType element.
561
- * - BUSINESS - A specific Business (for example, an organization or a company) is used as reference to a participant. The BUSINESS identifier can be in any format. To make a transaction connected to a specific username or bill number in a Business, the PartySubIdOrType element should be used.
562
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a specific business or organization is used as reference to a Party. For referencing a specific device under a specific business or organization, use the PartySubIdOrType element.
563
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.
564
- * - IBAN - A bank account number or FSP account ID is used as reference to a participant. The IBAN identifier can consist of up to 34 alphanumeric characters and should be entered without whitespace.
565
- * - ALIAS An alias is used as reference to a participant. The alias should be created in the FSP as an alternative reference to an account owner. Another example of an alias is a username in the FSP system. The ALIAS identifier can be in any format. It is also possible to use the PartySubIdOrType element for identifying an account under an Alias defined by the PartyIdentifier.
638
+ * Currency
639
+ * @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.
566
640
  * @enum {string}
567
641
  */
568
- PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
642
+ Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD";
569
643
  /**
570
- * PartyIdentifier
571
- * @description Identifier of the Party.
572
- * @example 16135551212
644
+ * Date
645
+ * @description The API data type Date is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. This format, as specified in ISO 8601, contains a date only. A more readable version of the format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”.
573
646
  */
574
- PartyIdentifier: string;
647
+ Date: string;
575
648
  /**
576
- * PartySubIdOrType
577
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
649
+ * DateofBirth (type Date)
650
+ * @description Date of Birth of the Party.
651
+ * @example 1966-06-16
578
652
  */
579
- PartySubIdOrType: string;
653
+ DateOfBirth: string;
580
654
  /**
581
- * FspId
582
- * @description FSP identifier.
655
+ * DateTime
656
+ * @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).
657
+ * @example 2016-05-24T08:38:08.699-04:00
583
658
  */
584
- FspId: string;
659
+ DateTime: string;
585
660
  /**
586
- * ExtensionKey
587
- * @description Extension key.
661
+ * ErrorCode
662
+ * @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.
663
+ * @example 5100
588
664
  */
589
- ExtensionKey: string;
665
+ ErrorCode: string;
590
666
  /**
591
- * ExtensionValue
592
- * @description Extension value.
667
+ * ErrorDescription
668
+ * @description Error description string.
593
669
  */
594
- ExtensionValue: string;
670
+ ErrorDescription: string;
671
+ /**
672
+ * ErrorInformation
673
+ * @description Data model for the complex type ErrorInformation.
674
+ */
675
+ ErrorInformation: {
676
+ errorCode: components["schemas"]["ErrorCode"];
677
+ errorDescription: components["schemas"]["ErrorDescription"];
678
+ extensionList?: components["schemas"]["ExtensionList"];
679
+ };
680
+ /**
681
+ * ErrorInformationObject
682
+ * @description Data model for the complex type object that contains ErrorInformation.
683
+ */
684
+ ErrorInformationObject: {
685
+ errorInformation: components["schemas"]["ErrorInformation"];
686
+ };
687
+ /**
688
+ * ErrorInformationResponse
689
+ * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
690
+ */
691
+ ErrorInformationResponse: {
692
+ errorInformation?: components["schemas"]["ErrorInformation"];
693
+ };
595
694
  /**
596
695
  * Extension
597
696
  * @description Data model for the complex type Extension.
@@ -600,6 +699,11 @@ export interface components {
600
699
  key: components["schemas"]["ExtensionKey"];
601
700
  value: components["schemas"]["ExtensionValue"];
602
701
  };
702
+ /**
703
+ * ExtensionKey
704
+ * @description Extension key.
705
+ */
706
+ ExtensionKey: string;
603
707
  /**
604
708
  * ExtensionList
605
709
  * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
@@ -609,26 +713,10 @@ export interface components {
609
713
  extension: components["schemas"]["Extension"][];
610
714
  };
611
715
  /**
612
- * PartyIdInfo
613
- * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
614
- */
615
- PartyIdInfo: {
616
- partyIdType: components["schemas"]["PartyIdType"];
617
- partyIdentifier: components["schemas"]["PartyIdentifier"];
618
- partySubIdOrType?: components["schemas"]["PartySubIdOrType"];
619
- fspId?: components["schemas"]["FspId"];
620
- extensionList?: components["schemas"]["ExtensionList"];
621
- };
622
- /**
623
- * MerchantClassificationCode
624
- * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.
625
- */
626
- MerchantClassificationCode: string;
627
- /**
628
- * PartyName
629
- * @description Name of the Party. Could be a real name or a nickname.
716
+ * ExtensionValue
717
+ * @description Extension value.
630
718
  */
631
- PartyName: string;
719
+ ExtensionValue: string;
632
720
  /**
633
721
  * FirstName
634
722
  * @description First name of the Party (Name Type).
@@ -636,140 +724,138 @@ export interface components {
636
724
  */
637
725
  FirstName: string;
638
726
  /**
639
- * MiddleName
640
- * @description Middle name of the Party (Name Type).
641
- * @example Johannes
727
+ * FspId
728
+ * @description FSP identifier.
642
729
  */
643
- MiddleName: string;
730
+ FspId: string;
644
731
  /**
645
- * LastName
646
- * @description Last name of the Party (Name Type).
647
- * @example Karlsson
732
+ * GeoCode
733
+ * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
648
734
  */
649
- LastName: string;
735
+ GeoCode: {
736
+ latitude: components["schemas"]["Latitude"];
737
+ longitude: components["schemas"]["Longitude"];
738
+ };
650
739
  /**
651
- * PartyComplexName
652
- * @description Data model for the complex type PartyComplexName.
740
+ * IlpCondition
741
+ * @description Condition that must be attached to the transfer by the Payer.
653
742
  */
654
- PartyComplexName: {
655
- firstName?: components["schemas"]["FirstName"];
656
- middleName?: components["schemas"]["MiddleName"];
657
- lastName?: components["schemas"]["LastName"];
658
- };
743
+ IlpCondition: string;
659
744
  /**
660
- * DateofBirth (type Date)
661
- * @description Date of Birth of the Party.
662
- * @example 1966-06-16
745
+ * IlpFulfilment
746
+ * @description Fulfilment that must be attached to the transfer by the Payee.
747
+ * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
663
748
  */
664
- DateOfBirth: string;
749
+ IlpFulfilment: string;
665
750
  /**
666
- * PartyPersonalInfo
667
- * @description Data model for the complex type PartyPersonalInfo.
751
+ * IlpPacket
752
+ * @description Information for recipient (transport layer information).
753
+ * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
668
754
  */
669
- PartyPersonalInfo: {
670
- complexName?: components["schemas"]["PartyComplexName"];
671
- dateOfBirth?: components["schemas"]["DateOfBirth"];
672
- };
755
+ IlpPacket: string;
673
756
  /**
674
- * Party
675
- * @description Data model for the complex type Party.
757
+ * IndividualQuote
758
+ * @description Data model for the complex type IndividualQuote.
676
759
  */
677
- Party: {
678
- partyIdInfo: components["schemas"]["PartyIdInfo"];
679
- merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"];
680
- name?: components["schemas"]["PartyName"];
681
- personalInfo?: components["schemas"]["PartyPersonalInfo"];
760
+ IndividualQuote: {
761
+ quoteId: components["schemas"]["CorrelationId"];
762
+ transactionId: components["schemas"]["CorrelationId"];
763
+ payee: components["schemas"]["Party"];
764
+ amountType: components["schemas"]["AmountType"];
765
+ amount: components["schemas"]["Money"];
766
+ fees?: components["schemas"]["Money"];
767
+ transactionType: components["schemas"]["TransactionType"];
768
+ note?: components["schemas"]["Note"];
769
+ extensionList?: components["schemas"]["ExtensionList"];
682
770
  };
683
771
  /**
684
- * Currency
685
- * @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.
686
- * @enum {string}
772
+ * IndividualQuoteResult
773
+ * @description Data model for the complex type IndividualQuoteResult.
687
774
  */
688
- Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD";
775
+ IndividualQuoteResult: {
776
+ quoteId: components["schemas"]["CorrelationId"];
777
+ payee?: components["schemas"]["Party"];
778
+ transferAmount?: components["schemas"]["Money"];
779
+ payeeReceiveAmount?: components["schemas"]["Money"];
780
+ payeeFspFee?: components["schemas"]["Money"];
781
+ payeeFspCommission?: components["schemas"]["Money"];
782
+ ilpPacket?: components["schemas"]["IlpPacket"];
783
+ condition?: components["schemas"]["IlpCondition"];
784
+ errorInformation?: components["schemas"]["ErrorInformation"];
785
+ extensionList?: components["schemas"]["ExtensionList"];
786
+ };
689
787
  /**
690
- * Amount
691
- * @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.
692
- * @example 123.45
788
+ * IndividualTransfer
789
+ * @description Data model for the complex type IndividualTransfer.
693
790
  */
694
- Amount: string;
791
+ IndividualTransfer: {
792
+ transferId: components["schemas"]["CorrelationId"];
793
+ transferAmount: components["schemas"]["Money"];
794
+ ilpPacket: components["schemas"]["IlpPacket"];
795
+ condition: components["schemas"]["IlpCondition"];
796
+ extensionList?: components["schemas"]["ExtensionList"];
797
+ };
695
798
  /**
696
- * Money
697
- * @description Data model for the complex type Money.
799
+ * IndividualTransferResult
800
+ * @description Data model for the complex type IndividualTransferResult.
698
801
  */
699
- Money: {
700
- currency: components["schemas"]["Currency"];
701
- amount: components["schemas"]["Amount"];
802
+ IndividualTransferResult: {
803
+ transferId: components["schemas"]["CorrelationId"];
804
+ fulfilment?: components["schemas"]["IlpFulfilment"];
805
+ errorInformation?: components["schemas"]["ErrorInformation"];
806
+ extensionList?: components["schemas"]["ExtensionList"];
702
807
  };
703
808
  /**
704
- * TransactionScenario
705
- * @description Below are the allowed values for the enumeration.
706
- * - DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.
707
- * - WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.
708
- * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
709
- * - PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.
710
- * - REFUND - Used for performing a refund of transaction.
711
- * @example DEPOSIT
712
- * @enum {string}
809
+ * Integer
810
+ * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits.
713
811
  */
714
- TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND";
812
+ Integer: string;
715
813
  /**
716
- * TransactionSubScenario
717
- * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
718
- * @example LOCALLY_DEFINED_SUBSCENARIO
814
+ * LastName
815
+ * @description Last name of the Party (Name Type).
816
+ * @example Karlsson
719
817
  */
720
- TransactionSubScenario: string;
818
+ LastName: string;
721
819
  /**
722
- * TransactionInitiator
723
- * @description Below are the allowed values for the enumeration.
724
- * - PAYER - Sender of funds is initiating the transaction. The account to send from is either owned by the Payer or is connected to the Payer in some way.
725
- * - PAYEE - Recipient of the funds is initiating the transaction by sending a transaction request. The Payer must approve the transaction, either automatically by a pre-generated OTP or by pre-approval of the Payee, or by manually approving in his or her own Device.
726
- * @example PAYEE
727
- * @enum {string}
820
+ * Latitude
821
+ * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
822
+ * @example +45.4215
728
823
  */
729
- TransactionInitiator: "PAYER" | "PAYEE";
824
+ Latitude: string;
730
825
  /**
731
- * TransactionInitiatorType
732
- * @description Below are the allowed values for the enumeration.
733
- * - CONSUMER - Consumer is the initiator of the transaction.
734
- * - AGENT - Agent is the initiator of the transaction.
735
- * - BUSINESS - Business is the initiator of the transaction.
736
- * - DEVICE - Device is the initiator of the transaction.
737
- * @example CONSUMER
738
- * @enum {string}
826
+ * Longitude
827
+ * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
828
+ * @example +75.6972
739
829
  */
740
- TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
830
+ Longitude: string;
741
831
  /**
742
- * RefundReason
743
- * @description Reason for the refund.
744
- * @example Free text indicating reason for the refund.
832
+ * MerchantClassificationCode
833
+ * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.
745
834
  */
746
- RefundReason: string;
835
+ MerchantClassificationCode: string;
747
836
  /**
748
- * Refund
749
- * @description Data model for the complex type Refund.
837
+ * MiddleName
838
+ * @description Middle name of the Party (Name Type).
839
+ * @example Johannes
750
840
  */
751
- Refund: {
752
- originalTransactionId: components["schemas"]["CorrelationId"];
753
- refundReason?: components["schemas"]["RefundReason"];
754
- };
841
+ MiddleName: string;
755
842
  /**
756
- * BalanceOfPayments
757
- * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed.
758
- * @example 123
843
+ * Money
844
+ * @description Data model for the complex type Money.
759
845
  */
760
- BalanceOfPayments: string;
846
+ Money: {
847
+ currency: components["schemas"]["Currency"];
848
+ amount: components["schemas"]["Amount"];
849
+ };
761
850
  /**
762
- * TransactionType
763
- * @description Data model for the complex type TransactionType.
851
+ * Name
852
+ * @description The API data type Name is a JSON String, restricted by a regular expression to avoid characters which are generally not used in a name.
853
+ *
854
+ * Regular Expression - The regular expression for restricting the Name type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a string consisting of whitespace only, all Unicode characters are allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,) and space characters ( ).
855
+ *
856
+ * **Note:** In some programming languages, Unicode support must be specifically enabled. For example, if Java is used, the flag UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
764
857
  */
765
- TransactionType: {
766
- scenario: components["schemas"]["TransactionScenario"];
767
- subScenario?: components["schemas"]["TransactionSubScenario"];
768
- initiator: components["schemas"]["TransactionInitiator"];
769
- initiatorType: components["schemas"]["TransactionInitiatorType"];
770
- refundInfo?: components["schemas"]["Refund"];
771
- balanceOfPayments?: components["schemas"]["BalanceOfPayments"];
772
- };
858
+ Name: string;
773
859
  /**
774
860
  * Note
775
861
  * @description Memo assigned to transaction.
@@ -777,50 +863,28 @@ export interface components {
777
863
  */
778
864
  Note: string;
779
865
  /**
780
- * Transaction
781
- * @description Data model for the complex type Transaction. The Transaction type is used to carry end-to-end data between the Payer FSP and the Payee FSP in the ILP Packet. Both the transactionId and the quoteId in the data model are decided by the Payer FSP in the POST /quotes request.
782
- */
783
- Transaction: {
784
- transactionId: components["schemas"]["CorrelationId"];
785
- quoteId: components["schemas"]["CorrelationId"];
786
- payee: components["schemas"]["Party"];
787
- payer: components["schemas"]["Party"];
788
- amount: components["schemas"]["Money"];
789
- transactionType: components["schemas"]["TransactionType"];
790
- note?: components["schemas"]["Note"];
791
- extensionList?: components["schemas"]["ExtensionList"];
792
- };
793
- /**
794
- * UndefinedEnum
795
- * @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_).
796
- */
797
- UndefinedEnum: string;
798
- /**
799
- * ErrorCode
800
- * @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.
801
- * @example 5100
802
- */
803
- ErrorCode: string;
804
- /**
805
- * ErrorDescription
806
- * @description Error description string.
866
+ * OtpValue
867
+ * @description The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed.
807
868
  */
808
- ErrorDescription: string;
869
+ OtpValue: string;
809
870
  /**
810
- * ErrorInformation
811
- * @description Data model for the complex type ErrorInformation.
871
+ * ParticipantsIDPutResponse
872
+ * @description The object sent in the PUT /participants/{ID} callback.
812
873
  */
813
- ErrorInformation: {
814
- errorCode: components["schemas"]["ErrorCode"];
815
- errorDescription: components["schemas"]["ErrorDescription"];
816
- extensionList?: components["schemas"]["ExtensionList"];
874
+ ParticipantsIDPutResponse: {
875
+ /** @description List of PartyResult elements that were either created or failed to be created. */
876
+ partyList: components["schemas"]["PartyResult"][];
877
+ currency?: components["schemas"]["Currency"];
817
878
  };
818
879
  /**
819
- * ErrorInformationResponse
820
- * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
880
+ * ParticipantsPostRequest
881
+ * @description The object sent in the POST /participants request.
821
882
  */
822
- ErrorInformationResponse: {
823
- errorInformation?: components["schemas"]["ErrorInformation"];
883
+ ParticipantsPostRequest: {
884
+ requestId: components["schemas"]["CorrelationId"];
885
+ /** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */
886
+ partyList: components["schemas"]["PartyIdInfo"][];
887
+ currency?: components["schemas"]["Currency"];
824
888
  };
825
889
  /**
826
890
  * ParticipantsTypeIDPutResponse
@@ -839,127 +903,127 @@ export interface components {
839
903
  extensionList?: components["schemas"]["ExtensionList"];
840
904
  };
841
905
  /**
842
- * ErrorInformationObject
843
- * @description Data model for the complex type object that contains ErrorInformation.
906
+ * PartiesTypeIDPutResponse
907
+ * @description The object sent in the PUT /parties/{Type}/{ID} callback.
844
908
  */
845
- ErrorInformationObject: {
846
- errorInformation: components["schemas"]["ErrorInformation"];
909
+ PartiesTypeIDPutResponse: {
910
+ party: components["schemas"]["Party"];
847
911
  };
848
912
  /**
849
- * ParticipantsPostRequest
850
- * @description The object sent in the POST /participants request.
851
- */
852
- ParticipantsPostRequest: {
853
- requestId: components["schemas"]["CorrelationId"];
854
- /** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */
855
- partyList: components["schemas"]["PartyIdInfo"][];
856
- currency?: components["schemas"]["Currency"];
857
- };
858
- /**
859
- * PartyResult
860
- * @description Data model for the complex type PartyResult.
913
+ * Party
914
+ * @description Data model for the complex type Party.
861
915
  */
862
- PartyResult: {
863
- partyId: components["schemas"]["PartyIdInfo"];
864
- errorInformation?: components["schemas"]["ErrorInformation"];
916
+ Party: {
917
+ partyIdInfo: components["schemas"]["PartyIdInfo"];
918
+ merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"];
919
+ name?: components["schemas"]["PartyName"];
920
+ personalInfo?: components["schemas"]["PartyPersonalInfo"];
865
921
  };
866
922
  /**
867
- * ParticipantsIDPutResponse
868
- * @description The object sent in the PUT /participants/{ID} callback.
923
+ * PartyComplexName
924
+ * @description Data model for the complex type PartyComplexName.
869
925
  */
870
- ParticipantsIDPutResponse: {
871
- /** @description List of PartyResult elements that were either created or failed to be created. */
872
- partyList: components["schemas"]["PartyResult"][];
873
- currency?: components["schemas"]["Currency"];
926
+ PartyComplexName: {
927
+ firstName?: components["schemas"]["FirstName"];
928
+ middleName?: components["schemas"]["MiddleName"];
929
+ lastName?: components["schemas"]["LastName"];
874
930
  };
875
931
  /**
876
- * PartiesTypeIDPutResponse
877
- * @description The object sent in the PUT /parties/{Type}/{ID} callback.
932
+ * PartyIdInfo
933
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
878
934
  */
879
- PartiesTypeIDPutResponse: {
880
- party: components["schemas"]["Party"];
935
+ PartyIdInfo: {
936
+ partyIdType: components["schemas"]["PartyIdType"];
937
+ partyIdentifier: components["schemas"]["PartyIdentifier"];
938
+ partySubIdOrType?: components["schemas"]["PartySubIdOrType"];
939
+ fspId?: components["schemas"]["FspId"];
940
+ extensionList?: components["schemas"]["ExtensionList"];
881
941
  };
882
942
  /**
883
- * Latitude
884
- * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
885
- * @example +45.4215
943
+ * PartyIdType
944
+ * @description Below are the allowed values for the enumeration.
945
+ * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.
946
+ * - EMAIL - An email is used as reference to a participant. The format of the email should be according to the informational [RFC 3696](https://tools.ietf.org/html/rfc3696).
947
+ * - PERSONAL_ID - A personal identifier is used as reference to a participant. Examples of personal identification are passport number, birth certificate number, and national registration number. The identifier number is added in the PartyIdentifier element. The personal identifier type is added in the PartySubIdOrType element.
948
+ * - BUSINESS - A specific Business (for example, an organization or a company) is used as reference to a participant. The BUSINESS identifier can be in any format. To make a transaction connected to a specific username or bill number in a Business, the PartySubIdOrType element should be used.
949
+ * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a specific business or organization is used as reference to a Party. For referencing a specific device under a specific business or organization, use the PartySubIdOrType element.
950
+ * - ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.
951
+ * - IBAN - A bank account number or FSP account ID is used as reference to a participant. The IBAN identifier can consist of up to 34 alphanumeric characters and should be entered without whitespace.
952
+ * - ALIAS An alias is used as reference to a participant. The alias should be created in the FSP as an alternative reference to an account owner. Another example of an alias is a username in the FSP system. The ALIAS identifier can be in any format. It is also possible to use the PartySubIdOrType element for identifying an account under an Alias defined by the PartyIdentifier.
953
+ * @enum {string}
886
954
  */
887
- Latitude: string;
955
+ PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
888
956
  /**
889
- * Longitude
890
- * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
891
- * @example +75.6972
957
+ * PartyIdentifier
958
+ * @description Identifier of the Party.
959
+ * @example 16135551212
892
960
  */
893
- Longitude: string;
961
+ PartyIdentifier: string;
894
962
  /**
895
- * GeoCode
896
- * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
963
+ * PartyName
964
+ * @description Name of the Party. Could be a real name or a nickname.
897
965
  */
898
- GeoCode: {
899
- latitude: components["schemas"]["Latitude"];
900
- longitude: components["schemas"]["Longitude"];
901
- };
966
+ PartyName: string;
902
967
  /**
903
- * AuthenticationType
904
- * @description Below are the allowed values for the enumeration AuthenticationType.
905
- * - OTP - One-time password generated by the Payer FSP.
906
- * - QRCODE - QR code used as One Time Password.
907
- * - U2F - U2F is a new addition isolated to Thirdparty stream.
908
- * @example OTP
909
- * @enum {string}
968
+ * PartyPersonalInfo
969
+ * @description Data model for the complex type PartyPersonalInfo.
910
970
  */
911
- AuthenticationType: "OTP" | "QRCODE" | "U2F";
971
+ PartyPersonalInfo: {
972
+ complexName?: components["schemas"]["PartyComplexName"];
973
+ dateOfBirth?: components["schemas"]["DateOfBirth"];
974
+ };
912
975
  /**
913
- * DateTime
914
- * @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).
915
- * @example 2016-05-24T08:38:08.699-04:00
976
+ * PartyResult
977
+ * @description Data model for the complex type PartyResult.
916
978
  */
917
- DateTime: string;
979
+ PartyResult: {
980
+ partyId: components["schemas"]["PartyIdInfo"];
981
+ errorInformation?: components["schemas"]["ErrorInformation"];
982
+ };
918
983
  /**
919
- * TransactionRequestsPostRequest
920
- * @description The object sent in the POST /transactionRequests request.
984
+ * PartySubIdOrType
985
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
921
986
  */
922
- TransactionRequestsPostRequest: {
923
- transactionRequestId: components["schemas"]["CorrelationId"];
924
- payee: components["schemas"]["Party"];
925
- payer: components["schemas"]["PartyIdInfo"];
926
- amount: components["schemas"]["Money"];
927
- transactionType: components["schemas"]["TransactionType"];
928
- note?: components["schemas"]["Note"];
929
- geoCode?: components["schemas"]["GeoCode"];
930
- authenticationType?: components["schemas"]["AuthenticationType"];
931
- expiration?: components["schemas"]["DateTime"];
932
- extensionList?: components["schemas"]["ExtensionList"];
933
- };
987
+ PartySubIdOrType: string;
934
988
  /**
935
- * TransactionRequestState
989
+ * PersonalIdentifierType
936
990
  * @description Below are the allowed values for the enumeration.
937
- * - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
938
- * - PENDING - Payer FSP has sent the transaction request to the Payer.
939
- * - ACCEPTED - Payer has approved the transaction.
940
- * - REJECTED - Payer has rejected the transaction.
941
- * @example RECEIVED
991
+ * - PASSPORT - A passport number is used as reference to a Party.
992
+ * - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party.
993
+ * - DRIVING_LICENSE - A driving license is used as reference to a Party.
994
+ * - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party.
995
+ * - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party.
996
+ * - EMPLOYER_ID - A tax identification number is used as reference to a Party.
997
+ * - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
998
+ * - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
999
+ * - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
1000
+ * - HEALTH_CARD - A health card number is used as reference to a Party.
1001
+ * - VOTERS_ID - A voter’s identification number is used as reference to a Party.
1002
+ * - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
1003
+ * - OTHER_ID - Any other type of identification type number is used as reference to a Party.
942
1004
  * @enum {string}
943
1005
  */
944
- TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED";
1006
+ PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID";
945
1007
  /**
946
- * TransactionRequestsIDPutResponse
947
- * @description The object sent in the PUT /transactionRequests/{ID} callback.
1008
+ * QRCODE
1009
+ * @description QR code used as a One Time Password.
948
1010
  */
949
- TransactionRequestsIDPutResponse: {
950
- transactionId?: components["schemas"]["CorrelationId"];
951
- transactionRequestState: components["schemas"]["TransactionRequestState"];
952
- extensionList?: components["schemas"]["ExtensionList"];
953
- };
1011
+ QRCODE: string;
954
1012
  /**
955
- * AmountType
956
- * @description Below are the allowed values for the enumeration AmountType.
957
- * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
958
- * - RECEIVE - Amount the Payer would like the Payee to receive, that is, the amount that should be sent to the receiver exclusive of any fees.
959
- * @example RECEIVE
960
- * @enum {string}
1013
+ * QuotesIDPutResponse
1014
+ * @description The object sent in the PUT /quotes/{ID} callback.
961
1015
  */
962
- AmountType: "SEND" | "RECEIVE";
1016
+ QuotesIDPutResponse: {
1017
+ transferAmount: components["schemas"]["Money"];
1018
+ payeeReceiveAmount?: components["schemas"]["Money"];
1019
+ payeeFspFee?: components["schemas"]["Money"];
1020
+ payeeFspCommission?: components["schemas"]["Money"];
1021
+ expiration: components["schemas"]["DateTime"];
1022
+ geoCode?: components["schemas"]["GeoCode"];
1023
+ ilpPacket: components["schemas"]["IlpPacket"];
1024
+ condition: components["schemas"]["IlpCondition"];
1025
+ extensionList?: components["schemas"]["ExtensionList"];
1026
+ };
963
1027
  /**
964
1028
  * QuotesPostRequest
965
1029
  * @description The object sent in the POST /quotes request.
@@ -980,137 +1044,106 @@ export interface components {
980
1044
  extensionList?: components["schemas"]["ExtensionList"];
981
1045
  };
982
1046
  /**
983
- * IlpPacket
984
- * @description Information for recipient (transport layer information).
985
- * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
986
- */
987
- IlpPacket: string;
988
- /**
989
- * IlpCondition
990
- * @description Condition that must be attached to the transfer by the Payer.
991
- */
992
- IlpCondition: string;
993
- /**
994
- * QuotesIDPutResponse
995
- * @description The object sent in the PUT /quotes/{ID} callback.
1047
+ * Refund
1048
+ * @description Data model for the complex type Refund.
996
1049
  */
997
- QuotesIDPutResponse: {
998
- transferAmount: components["schemas"]["Money"];
999
- payeeReceiveAmount?: components["schemas"]["Money"];
1000
- payeeFspFee?: components["schemas"]["Money"];
1001
- payeeFspCommission?: components["schemas"]["Money"];
1002
- expiration: components["schemas"]["DateTime"];
1003
- geoCode?: components["schemas"]["GeoCode"];
1004
- ilpPacket: components["schemas"]["IlpPacket"];
1005
- condition: components["schemas"]["IlpCondition"];
1006
- extensionList?: components["schemas"]["ExtensionList"];
1050
+ Refund: {
1051
+ originalTransactionId: components["schemas"]["CorrelationId"];
1052
+ refundReason?: components["schemas"]["RefundReason"];
1007
1053
  };
1008
1054
  /**
1009
- * OtpValue
1010
- * @description The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed.
1011
- */
1012
- OtpValue: string;
1013
- /**
1014
- * QRCODE
1015
- * @description QR code used as a One Time Password.
1016
- */
1017
- QRCODE: string;
1018
- /**
1019
- * U2FPIN
1020
- * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
1021
- */
1022
- U2FPIN: string;
1023
- /**
1024
- * U2FPinValue
1025
- * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
1055
+ * RefundReason
1056
+ * @description Reason for the refund.
1057
+ * @example Free text indicating reason for the refund.
1026
1058
  */
1027
- U2FPinValue: {
1028
- /** @description U2F challenge-response. */
1029
- pinValue: components["schemas"]["U2FPIN"];
1030
- /** @description Sequential counter used for cloning detection. Present only for U2F authentication. */
1031
- counter: components["schemas"]["Integer"];
1032
- };
1059
+ RefundReason: string;
1033
1060
  /**
1034
- * AuthenticationValue
1035
- * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
1061
+ * TokenCode
1062
+ * @description The API data type TokenCode is a JSON String between 4 and 32 characters, consisting of digits or upper- or lowercase characters from a to z.
1036
1063
  */
1037
- AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"];
1064
+ TokenCode: string;
1038
1065
  /**
1039
- * AuthenticationInfo
1040
- * @description Data model for the complex type AuthenticationInfo.
1066
+ * Transaction
1067
+ * @description Data model for the complex type Transaction. The Transaction type is used to carry end-to-end data between the Payer FSP and the Payee FSP in the ILP Packet. Both the transactionId and the quoteId in the data model are decided by the Payer FSP in the POST /quotes request.
1041
1068
  */
1042
- AuthenticationInfo: {
1043
- authentication: components["schemas"]["AuthenticationType"];
1044
- authenticationValue: components["schemas"]["AuthenticationValue"];
1069
+ Transaction: {
1070
+ transactionId: components["schemas"]["CorrelationId"];
1071
+ quoteId: components["schemas"]["CorrelationId"];
1072
+ payee: components["schemas"]["Party"];
1073
+ payer: components["schemas"]["Party"];
1074
+ amount: components["schemas"]["Money"];
1075
+ transactionType: components["schemas"]["TransactionType"];
1076
+ note?: components["schemas"]["Note"];
1077
+ extensionList?: components["schemas"]["ExtensionList"];
1045
1078
  };
1046
1079
  /**
1047
- * AuthorizationResponse
1080
+ * TransactionInitiator
1048
1081
  * @description Below are the allowed values for the enumeration.
1049
- * - ENTERED - Consumer entered the authentication value.
1050
- * - REJECTED - Consumer rejected the transaction.
1051
- * - RESEND - Consumer requested to resend the authentication value.
1052
- * @example ENTERED
1082
+ * - PAYER - Sender of funds is initiating the transaction. The account to send from is either owned by the Payer or is connected to the Payer in some way.
1083
+ * - PAYEE - Recipient of the funds is initiating the transaction by sending a transaction request. The Payer must approve the transaction, either automatically by a pre-generated OTP or by pre-approval of the Payee, or by manually approving in his or her own Device.
1084
+ * @example PAYEE
1053
1085
  * @enum {string}
1054
1086
  */
1055
- AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND";
1056
- /**
1057
- * AuthorizationsIDPutResponse
1058
- * @description The object sent in the PUT /authorizations/{ID} callback.
1059
- */
1060
- AuthorizationsIDPutResponse: {
1061
- authenticationInfo?: components["schemas"]["AuthenticationInfo"];
1062
- responseType: components["schemas"]["AuthorizationResponse"];
1063
- };
1064
- /**
1065
- * TransfersPostRequest
1066
- * @description The object sent in the POST /transfers request.
1067
- */
1068
- TransfersPostRequest: {
1069
- transferId: components["schemas"]["CorrelationId"];
1070
- payeeFsp: components["schemas"]["FspId"];
1071
- payerFsp: components["schemas"]["FspId"];
1072
- amount: components["schemas"]["Money"];
1073
- ilpPacket: components["schemas"]["IlpPacket"];
1074
- condition: components["schemas"]["IlpCondition"];
1075
- expiration: components["schemas"]["DateTime"];
1076
- extensionList?: components["schemas"]["ExtensionList"];
1077
- };
1087
+ TransactionInitiator: "PAYER" | "PAYEE";
1078
1088
  /**
1079
- * IlpFulfilment
1080
- * @description Fulfilment that must be attached to the transfer by the Payee.
1081
- * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
1089
+ * TransactionInitiatorType
1090
+ * @description Below are the allowed values for the enumeration.
1091
+ * - CONSUMER - Consumer is the initiator of the transaction.
1092
+ * - AGENT - Agent is the initiator of the transaction.
1093
+ * - BUSINESS - Business is the initiator of the transaction.
1094
+ * - DEVICE - Device is the initiator of the transaction.
1095
+ * @example CONSUMER
1096
+ * @enum {string}
1082
1097
  */
1083
- IlpFulfilment: string;
1098
+ TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
1084
1099
  /**
1085
- * TransferState
1100
+ * TransactionRequestState
1086
1101
  * @description Below are the allowed values for the enumeration.
1087
- * - RECEIVED - Next ledger has received the transfer.
1088
- * - RESERVED - Next ledger has reserved the transfer.
1089
- * - COMMITTED - Next ledger has successfully performed the transfer.
1090
- * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
1091
- * @example RESERVED
1102
+ * - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
1103
+ * - PENDING - Payer FSP has sent the transaction request to the Payer.
1104
+ * - ACCEPTED - Payer has approved the transaction.
1105
+ * - REJECTED - Payer has rejected the transaction.
1106
+ * @example RECEIVED
1092
1107
  * @enum {string}
1093
1108
  */
1094
- TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
1109
+ TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED";
1095
1110
  /**
1096
- * TransfersIDPutResponse
1097
- * @description The object sent in the PUT /transfers/{ID} callback.
1111
+ * TransactionRequestsIDPutResponse
1112
+ * @description The object sent in the PUT /transactionRequests/{ID} callback.
1098
1113
  */
1099
- TransfersIDPutResponse: {
1100
- fulfilment?: components["schemas"]["IlpFulfilment"];
1101
- completedTimestamp?: components["schemas"]["DateTime"];
1102
- transferState: components["schemas"]["TransferState"];
1114
+ TransactionRequestsIDPutResponse: {
1115
+ transactionId?: components["schemas"]["CorrelationId"];
1116
+ transactionRequestState: components["schemas"]["TransactionRequestState"];
1103
1117
  extensionList?: components["schemas"]["ExtensionList"];
1104
1118
  };
1105
1119
  /**
1106
- * TransfersIDPatchResponse
1107
- * @description PATCH /transfers/{ID} object
1120
+ * TransactionRequestsPostRequest
1121
+ * @description The object sent in the POST /transactionRequests request.
1108
1122
  */
1109
- TransfersIDPatchResponse: {
1110
- completedTimestamp: components["schemas"]["DateTime"];
1111
- transferState: components["schemas"]["TransferState"];
1123
+ TransactionRequestsPostRequest: {
1124
+ transactionRequestId: components["schemas"]["CorrelationId"];
1125
+ payee: components["schemas"]["Party"];
1126
+ payer: components["schemas"]["PartyIdInfo"];
1127
+ amount: components["schemas"]["Money"];
1128
+ transactionType: components["schemas"]["TransactionType"];
1129
+ note?: components["schemas"]["Note"];
1130
+ geoCode?: components["schemas"]["GeoCode"];
1131
+ authenticationType?: components["schemas"]["AuthenticationType"];
1132
+ expiration?: components["schemas"]["DateTime"];
1112
1133
  extensionList?: components["schemas"]["ExtensionList"];
1113
1134
  };
1135
+ /**
1136
+ * TransactionScenario
1137
+ * @description Below are the allowed values for the enumeration.
1138
+ * - DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.
1139
+ * - WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.
1140
+ * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
1141
+ * - PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.
1142
+ * - REFUND - Used for performing a refund of transaction.
1143
+ * @example DEPOSIT
1144
+ * @enum {string}
1145
+ */
1146
+ TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND";
1114
1147
  /**
1115
1148
  * TransactionState
1116
1149
  * @description Below are the allowed values for the enumeration.
@@ -1123,11 +1156,23 @@ export interface components {
1123
1156
  */
1124
1157
  TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED";
1125
1158
  /**
1126
- * Code
1127
- * @description Any code/token returned by the Payee FSP (TokenCode Type).
1128
- * @example Test-Code
1159
+ * TransactionSubScenario
1160
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
1161
+ * @example LOCALLY_DEFINED_SUBSCENARIO
1129
1162
  */
1130
- Code: string;
1163
+ TransactionSubScenario: string;
1164
+ /**
1165
+ * TransactionType
1166
+ * @description Data model for the complex type TransactionType.
1167
+ */
1168
+ TransactionType: {
1169
+ scenario: components["schemas"]["TransactionScenario"];
1170
+ subScenario?: components["schemas"]["TransactionSubScenario"];
1171
+ initiator: components["schemas"]["TransactionInitiator"];
1172
+ initiatorType: components["schemas"]["TransactionInitiatorType"];
1173
+ refundInfo?: components["schemas"]["Refund"];
1174
+ balanceOfPayments?: components["schemas"]["BalanceOfPayments"];
1175
+ };
1131
1176
  /**
1132
1177
  * TransactionsIDPutResponse
1133
1178
  * @description The object sent in the PUT /transactions/{ID} callback.
@@ -1139,118 +1184,69 @@ export interface components {
1139
1184
  extensionList?: components["schemas"]["ExtensionList"];
1140
1185
  };
1141
1186
  /**
1142
- * IndividualQuote
1143
- * @description Data model for the complex type IndividualQuote.
1144
- */
1145
- IndividualQuote: {
1146
- quoteId: components["schemas"]["CorrelationId"];
1147
- transactionId: components["schemas"]["CorrelationId"];
1148
- payee: components["schemas"]["Party"];
1149
- amountType: components["schemas"]["AmountType"];
1150
- amount: components["schemas"]["Money"];
1151
- fees?: components["schemas"]["Money"];
1152
- transactionType: components["schemas"]["TransactionType"];
1153
- note?: components["schemas"]["Note"];
1154
- extensionList?: components["schemas"]["ExtensionList"];
1155
- };
1156
- /**
1157
- * BulkQuotesPostRequest
1158
- * @description The object sent in the POST /bulkQuotes request.
1187
+ * TransferState
1188
+ * @description Below are the allowed values for the enumeration.
1189
+ * - RECEIVED - Next ledger has received the transfer.
1190
+ * - RESERVED - Next ledger has reserved the transfer.
1191
+ * - COMMITTED - Next ledger has successfully performed the transfer.
1192
+ * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
1193
+ * @example RESERVED
1194
+ * @enum {string}
1159
1195
  */
1160
- BulkQuotesPostRequest: {
1161
- bulkQuoteId: components["schemas"]["CorrelationId"];
1162
- payer: components["schemas"]["Party"];
1163
- geoCode?: components["schemas"]["GeoCode"];
1164
- expiration?: components["schemas"]["DateTime"];
1165
- /** @description List of quotes elements. */
1166
- individualQuotes: components["schemas"]["IndividualQuote"][];
1167
- extensionList?: components["schemas"]["ExtensionList"];
1168
- };
1196
+ TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
1169
1197
  /**
1170
- * IndividualQuoteResult
1171
- * @description Data model for the complex type IndividualQuoteResult.
1198
+ * TransfersIDPatchResponse
1199
+ * @description PATCH /transfers/{ID} object
1172
1200
  */
1173
- IndividualQuoteResult: {
1174
- quoteId: components["schemas"]["CorrelationId"];
1175
- payee?: components["schemas"]["Party"];
1176
- transferAmount?: components["schemas"]["Money"];
1177
- payeeReceiveAmount?: components["schemas"]["Money"];
1178
- payeeFspFee?: components["schemas"]["Money"];
1179
- payeeFspCommission?: components["schemas"]["Money"];
1180
- ilpPacket?: components["schemas"]["IlpPacket"];
1181
- condition?: components["schemas"]["IlpCondition"];
1182
- errorInformation?: components["schemas"]["ErrorInformation"];
1201
+ TransfersIDPatchResponse: {
1202
+ completedTimestamp: components["schemas"]["DateTime"];
1203
+ transferState: components["schemas"]["TransferState"];
1183
1204
  extensionList?: components["schemas"]["ExtensionList"];
1184
1205
  };
1185
1206
  /**
1186
- * BulkQuotesIDPutResponse
1187
- * @description The object sent in the PUT /bulkQuotes/{ID} callback.
1207
+ * TransfersIDPutResponse
1208
+ * @description The object sent in the PUT /transfers/{ID} callback.
1188
1209
  */
1189
- BulkQuotesIDPutResponse: {
1190
- /** @description Fees for each individual transaction, if any of them are charged per transaction. */
1191
- individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][];
1192
- expiration: components["schemas"]["DateTime"];
1210
+ TransfersIDPutResponse: {
1211
+ fulfilment?: components["schemas"]["IlpFulfilment"];
1212
+ completedTimestamp?: components["schemas"]["DateTime"];
1213
+ transferState: components["schemas"]["TransferState"];
1193
1214
  extensionList?: components["schemas"]["ExtensionList"];
1194
1215
  };
1195
1216
  /**
1196
- * IndividualTransfer
1197
- * @description Data model for the complex type IndividualTransfer.
1217
+ * TransfersPostRequest
1218
+ * @description The object sent in the POST /transfers request.
1198
1219
  */
1199
- IndividualTransfer: {
1220
+ TransfersPostRequest: {
1200
1221
  transferId: components["schemas"]["CorrelationId"];
1201
- transferAmount: components["schemas"]["Money"];
1222
+ payeeFsp: components["schemas"]["FspId"];
1223
+ payerFsp: components["schemas"]["FspId"];
1224
+ amount: components["schemas"]["Money"];
1202
1225
  ilpPacket: components["schemas"]["IlpPacket"];
1203
1226
  condition: components["schemas"]["IlpCondition"];
1204
- extensionList?: components["schemas"]["ExtensionList"];
1205
- };
1206
- /**
1207
- * BulkTransfersPostRequest
1208
- * @description The object sent in the POST /bulkTransfers request.
1209
- */
1210
- BulkTransfersPostRequest: {
1211
- bulkTransferId: components["schemas"]["CorrelationId"];
1212
- bulkQuoteId: components["schemas"]["CorrelationId"];
1213
- payerFsp: components["schemas"]["FspId"];
1214
- payeeFsp: components["schemas"]["FspId"];
1215
- /** @description List of IndividualTransfer elements. */
1216
- individualTransfers: components["schemas"]["IndividualTransfer"][];
1217
1227
  expiration: components["schemas"]["DateTime"];
1218
1228
  extensionList?: components["schemas"]["ExtensionList"];
1219
1229
  };
1220
1230
  /**
1221
- * IndividualTransferResult
1222
- * @description Data model for the complex type IndividualTransferResult.
1231
+ * U2FPIN
1232
+ * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
1223
1233
  */
1224
- IndividualTransferResult: {
1225
- transferId: components["schemas"]["CorrelationId"];
1226
- fulfilment?: components["schemas"]["IlpFulfilment"];
1227
- errorInformation?: components["schemas"]["ErrorInformation"];
1228
- extensionList?: components["schemas"]["ExtensionList"];
1229
- };
1234
+ U2FPIN: string;
1230
1235
  /**
1231
- * BulkTransactionState
1232
- * @description Below are the allowed values for the enumeration.
1233
- * - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
1234
- * - PENDING - Payee FSP has validated the bulk transfer.
1235
- * - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
1236
- * - PROCESSING - Payee FSP has started to transfer fund to the Payees.
1237
- * - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
1238
- * - REJECTED - Payee FSP has rejected to process the bulk transfer.
1239
- * @example RECEIVED
1240
- * @enum {string}
1236
+ * U2FPinValue
1237
+ * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
1241
1238
  */
1242
- BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED";
1239
+ U2FPinValue: {
1240
+ /** @description U2F challenge-response. */
1241
+ pinValue: components["schemas"]["U2FPIN"];
1242
+ /** @description Sequential counter used for cloning detection. Present only for U2F authentication. */
1243
+ counter: components["schemas"]["Integer"];
1244
+ };
1243
1245
  /**
1244
- * BulkTransfersIDPutResponse
1245
- * @description The object sent in the PUT /bulkTransfers/{ID} callback.
1246
+ * UndefinedEnum
1247
+ * @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_).
1246
1248
  */
1247
- BulkTransfersIDPutResponse: {
1248
- completedTimestamp?: components["schemas"]["DateTime"];
1249
- /** @description List of IndividualTransferResult elements. */
1250
- individualTransferResults?: components["schemas"]["IndividualTransferResult"][];
1251
- bulkTransferState: components["schemas"]["BulkTransferState"];
1252
- extensionList?: components["schemas"]["ExtensionList"];
1253
- };
1249
+ UndefinedEnum: string;
1254
1250
  };
1255
1251
  responses: {
1256
1252
  /** @description OK */
@@ -1343,42 +1339,42 @@ export interface components {
1343
1339
  };
1344
1340
  };
1345
1341
  parameters: {
1346
- /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
1347
- Type: string;
1348
- /** @description The identifier value. */
1349
- ID: string;
1342
+ /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
1343
+ Accept: string;
1344
+ /**
1345
+ * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
1346
+ *
1347
+ * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
1348
+ */
1349
+ "Content-Length"?: number;
1350
1350
  /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
1351
1351
  "Content-Type": string;
1352
1352
  /** @description The `Date` header field indicates the date when the request was sent. */
1353
1353
  Date: string;
1354
- /**
1355
- * @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
1356
- *
1357
- * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
1358
- */
1359
- "X-Forwarded-For"?: string;
1360
- /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
1361
- "FSPIOP-Source": string;
1362
1354
  /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
1363
1355
  "FSPIOP-Destination"?: string;
1364
1356
  /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
1365
1357
  "FSPIOP-Encryption"?: string;
1358
+ /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
1359
+ "FSPIOP-HTTP-Method"?: string;
1366
1360
  /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
1367
1361
  "FSPIOP-Signature"?: string;
1362
+ /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
1363
+ "FSPIOP-Source": string;
1368
1364
  /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
1369
1365
  "FSPIOP-URI"?: string;
1370
- /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
1371
- "FSPIOP-HTTP-Method"?: string;
1372
- /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
1373
- Accept: string;
1366
+ /** @description The identifier value. */
1367
+ ID: string;
1368
+ /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
1369
+ SubId: string;
1370
+ /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
1371
+ Type: string;
1374
1372
  /**
1375
- * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
1373
+ * @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
1376
1374
  *
1377
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
1375
+ * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
1378
1376
  */
1379
- "Content-Length"?: number;
1380
- /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
1381
- SubId: string;
1377
+ "X-Forwarded-For"?: string;
1382
1378
  };
1383
1379
  requestBodies: never;
1384
1380
  headers: {
@@ -1396,20 +1392,6 @@ export interface components {
1396
1392
  export type $defs = Record<string, never>;
1397
1393
  export type external = Record<string, never>;
1398
1394
  export interface operations {
1399
- /** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
1400
- test: {
1401
- requestBody?: {
1402
- content: {
1403
- "application/json": components["schemas"]["BinaryString"] | components["schemas"]["BinaryString32"] | components["schemas"]["Date"] | components["schemas"]["Integer"] | components["schemas"]["Name"] | components["schemas"]["PersonalIdentifierType"] | components["schemas"]["TokenCode"] | components["schemas"]["Transaction"] | components["schemas"]["UndefinedEnum"];
1404
- };
1405
- };
1406
- responses: {
1407
- /** @description Ok */
1408
- 200: {
1409
- content: never;
1410
- };
1411
- };
1412
- };
1413
1395
  /**
1414
1396
  * Look up participant information
1415
1397
  * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.