@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
@@ -2,17 +2,12 @@ openapi: 3.0.2
2
2
  info:
3
3
  version: '1.0'
4
4
  title: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
5
- description: >-
6
- Based on [API Definition version
7
- 1.0](https://github.com/mojaloop/mojaloop-specification/blob/develop/API%20Definition%20v1.0.pdf).
5
+ description: |-
6
+ Based on [API Definition version 1.0](https://github.com/mojaloop/mojaloop-specification/blob/develop/API%20Definition%20v1.0.pdf).
8
7
 
9
-
10
- **Note:** The API supports a maximum size of 65536 bytes (64 Kilobytes) in
11
- the HTTP header.
8
+ **Note:** The API supports a maximum size of 65536 bytes (64 Kilobytes) in the HTTP header.
12
9
  license:
13
- name: >-
14
- Open API for FSP Interoperability (FSPIOP) (Implementation Friendly
15
- Version)
10
+ name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
16
11
  url: https://github.com/mojaloop/mojaloop-specification/blob/develop/LICENSE.md
17
12
  servers:
18
13
  - url: protocol://hostname:<port>/switch/
@@ -25,10 +20,7 @@ servers:
25
20
  paths:
26
21
  /interface:
27
22
  post:
28
- description: >-
29
- Essential path to include schema components that are not used so that
30
- these definitions get included into the openapi-cli bundle api
31
- definition so that they get converted into typescript definitions.
23
+ description: Essential path to include schema components 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.
32
24
  operationId: Interface
33
25
  requestBody:
34
26
  content:
@@ -104,12 +96,7 @@ paths:
104
96
  - $ref: '#/components/parameters/FSPIOP-URI'
105
97
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
106
98
  post:
107
- description: >-
108
- The HTTP request `POST /participants/{Type}/{ID}` (or `POST
109
- /participants/{Type}/{ID}/{SubId}`) is used to create information in the
110
- server regarding the provided identity, defined by `{Type}`, `{ID}`, and
111
- optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789`
112
- or `POST /participants/BUSINESS/shoecompany/employee1`).
99
+ description: The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`).
113
100
  summary: Create participant information
114
101
  tags:
115
102
  - participants
@@ -144,15 +131,7 @@ paths:
144
131
  '503':
145
132
  $ref: '#/components/responses/503'
146
133
  get:
147
- description: >-
148
- The HTTP request `GET /participants/{Type}/{ID}` (or `GET
149
- /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the
150
- requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`,
151
- is located (for example, `GET /participants/MSISDN/123456789`, or `GET
152
- /participants/BUSINESS/shoecompany/employee1`). This HTTP request should
153
- support a query string for filtering of currency. To use filtering of
154
- currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ`
155
- should be used, where `XYZ` is the requested currency.
134
+ 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.
156
135
  summary: Look up participant information
157
136
  tags:
158
137
  - participants
@@ -179,13 +158,7 @@ paths:
179
158
  '503':
180
159
  $ref: '#/components/responses/503'
181
160
  put:
182
- description: >-
183
- The callback `PUT /participants/{Type}/{ID}` (or `PUT
184
- /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a
185
- successful result of the lookup, creation, or deletion of the FSP
186
- information related to the Party. If the FSP information is deleted, the
187
- fspId element should be empty; otherwise the element should include the
188
- FSP information for the Party.
161
+ description: The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
189
162
  summary: Return participant information
190
163
  tags:
191
164
  - participants
@@ -219,20 +192,10 @@ paths:
219
192
  '503':
220
193
  $ref: '#/components/responses/503'
221
194
  delete:
222
- description: >-
223
- The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE
224
- /participants/{Type}/{ID}/{SubId}`) is used to delete information in the
225
- server regarding the provided identity, defined by `{Type}` and `{ID}`)
226
- (for example, `DELETE /participants/MSISDN/123456789`), and optionally
227
- `{SubId}`. This HTTP request should support a query string to delete FSP
228
- information regarding a specific currency only. To delete a specific
229
- currency only, the HTTP request `DELETE
230
- /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is
231
- the requested currency.
232
-
195
+ description: |-
196
+ The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
233
197
 
234
- **Note:** The Account Lookup System should verify that it is the Party’s
235
- current FSP that is deleting the FSP information.
198
+ **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
236
199
  summary: Delete participant information
237
200
  tags:
238
201
  - participants
@@ -260,11 +223,7 @@ paths:
260
223
  $ref: '#/components/responses/503'
261
224
  /participants/{Type}/{ID}/error:
262
225
  put:
263
- description: >-
264
- If the server is unable to find, create or delete the associated FSP of
265
- the provided identity, or another processing error occurred, the error
266
- callback `PUT /participants/{Type}/{ID}/error` (or `PUT
267
- /participants/{Type}/{ID}/{SubId}/error`) is used.
226
+ description: If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
268
227
  summary: Return participant information error
269
228
  tags:
270
229
  - participants
@@ -323,12 +282,7 @@ paths:
323
282
  - $ref: '#/components/parameters/FSPIOP-URI'
324
283
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
325
284
  post:
326
- description: >-
327
- The HTTP request `POST /participants/{Type}/{ID}` (or `POST
328
- /participants/{Type}/{ID}/{SubId}`) is used to create information in the
329
- server regarding the provided identity, defined by `{Type}`, `{ID}`, and
330
- optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789`
331
- or `POST /participants/BUSINESS/shoecompany/employee1`).
285
+ description: The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`).
332
286
  summary: Create participant information
333
287
  tags:
334
288
  - participants
@@ -363,15 +317,7 @@ paths:
363
317
  '503':
364
318
  $ref: '#/components/responses/503'
365
319
  get:
366
- description: >-
367
- The HTTP request `GET /participants/{Type}/{ID}` (or `GET
368
- /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the
369
- requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`,
370
- is located (for example, `GET /participants/MSISDN/123456789`, or `GET
371
- /participants/BUSINESS/shoecompany/employee1`). This HTTP request should
372
- support a query string for filtering of currency. To use filtering of
373
- currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ`
374
- should be used, where `XYZ` is the requested currency.
320
+ 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.
375
321
  summary: Look up participant information
376
322
  tags:
377
323
  - participants
@@ -398,13 +344,7 @@ paths:
398
344
  '503':
399
345
  $ref: '#/components/responses/503'
400
346
  put:
401
- description: >-
402
- The callback `PUT /participants/{Type}/{ID}` (or `PUT
403
- /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a
404
- successful result of the lookup, creation, or deletion of the FSP
405
- information related to the Party. If the FSP information is deleted, the
406
- fspId element should be empty; otherwise the element should include the
407
- FSP information for the Party.
347
+ description: The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
408
348
  summary: Return participant information
409
349
  tags:
410
350
  - participants
@@ -438,20 +378,10 @@ paths:
438
378
  '503':
439
379
  $ref: '#/components/responses/503'
440
380
  delete:
441
- description: >-
442
- The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE
443
- /participants/{Type}/{ID}/{SubId}`) is used to delete information in the
444
- server regarding the provided identity, defined by `{Type}` and `{ID}`)
445
- (for example, `DELETE /participants/MSISDN/123456789`), and optionally
446
- `{SubId}`. This HTTP request should support a query string to delete FSP
447
- information regarding a specific currency only. To delete a specific
448
- currency only, the HTTP request `DELETE
449
- /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is
450
- the requested currency.
451
-
381
+ description: |-
382
+ The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
452
383
 
453
- **Note:** The Account Lookup System should verify that it is the Party’s
454
- current FSP that is deleting the FSP information.
384
+ **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
455
385
  summary: Delete participant information
456
386
  tags:
457
387
  - participants
@@ -479,11 +409,7 @@ paths:
479
409
  $ref: '#/components/responses/503'
480
410
  /participants/{Type}/{ID}/{SubId}/error:
481
411
  put:
482
- description: >-
483
- If the server is unable to find, create or delete the associated FSP of
484
- the provided identity, or another processing error occurred, the error
485
- callback `PUT /participants/{Type}/{ID}/error` (or `PUT
486
- /participants/{Type}/{ID}/{SubId}/error`) is used.
412
+ description: If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
487
413
  summary: Return participant information error
488
414
  tags:
489
415
  - participants
@@ -530,12 +456,7 @@ paths:
530
456
  $ref: '#/components/responses/503'
531
457
  /participants:
532
458
  post:
533
- description: >-
534
- The HTTP request `POST /participants` is used to create information in
535
- the server regarding the provided list of identities. This request
536
- should be used for bulk creation of FSP information for more than one
537
- Party. The optional currency parameter should indicate that each
538
- provided Party supports the currency.
459
+ description: The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.
539
460
  summary: Create bulk participant information
540
461
  tags:
541
462
  - participants
@@ -580,9 +501,7 @@ paths:
580
501
  $ref: '#/components/responses/503'
581
502
  /participants/{ID}:
582
503
  put:
583
- description: >-
584
- The callback `PUT /participants/{ID}` is used to inform the client of
585
- the result of the creation of the provided list of identities.
504
+ description: The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
586
505
  summary: Return bulk participant information
587
506
  tags:
588
507
  - participants
@@ -627,11 +546,7 @@ paths:
627
546
  $ref: '#/components/responses/503'
628
547
  /participants/{ID}/error:
629
548
  put:
630
- description: >-
631
- If there is an error during FSP information creation in the server, the
632
- error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the
633
- URI should contain the requestId that was used for the creation of the
634
- participant information.
549
+ description: If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information.
635
550
  summary: Return bulk participant information error
636
551
  tags:
637
552
  - participants
@@ -688,12 +603,7 @@ paths:
688
603
  - $ref: '#/components/parameters/FSPIOP-URI'
689
604
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
690
605
  get:
691
- description: >-
692
- The HTTP request `GET /parties/{Type}/{ID}` (or `GET
693
- /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding
694
- the requested Party, defined by `{Type}`, `{ID}` and optionally
695
- `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET
696
- /parties/BUSINESS/shoecompany/employee1`).
606
+ description: The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
697
607
  summary: Look up party information
698
608
  tags:
699
609
  - parties
@@ -720,10 +630,7 @@ paths:
720
630
  '503':
721
631
  $ref: '#/components/responses/503'
722
632
  put:
723
- description: >-
724
- The callback `PUT /parties/{Type}/{ID}` (or `PUT
725
- /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a
726
- successful result of the Party information lookup.
633
+ description: The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
727
634
  summary: Return party information
728
635
  tags:
729
636
  - parties
@@ -758,11 +665,7 @@ paths:
758
665
  $ref: '#/components/responses/503'
759
666
  /parties/{Type}/{ID}/error:
760
667
  put:
761
- description: >-
762
- If the server is unable to find Party information of the provided
763
- identity, or another processing error occurred, the error callback `PUT
764
- /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`)
765
- is used.
668
+ description: If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used.
766
669
  summary: Return party information error
767
670
  tags:
768
671
  - parties
@@ -821,12 +724,7 @@ paths:
821
724
  - $ref: '#/components/parameters/FSPIOP-URI'
822
725
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
823
726
  get:
824
- description: >-
825
- The HTTP request `GET /parties/{Type}/{ID}` (or `GET
826
- /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding
827
- the requested Party, defined by `{Type}`, `{ID}` and optionally
828
- `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET
829
- /parties/BUSINESS/shoecompany/employee1`).
727
+ description: The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
830
728
  summary: Look up party information
831
729
  tags:
832
730
  - parties
@@ -853,10 +751,7 @@ paths:
853
751
  '503':
854
752
  $ref: '#/components/responses/503'
855
753
  put:
856
- description: >-
857
- The callback `PUT /parties/{Type}/{ID}` (or `PUT
858
- /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a
859
- successful result of the Party information lookup.
754
+ description: The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
860
755
  summary: Return party information
861
756
  tags:
862
757
  - parties
@@ -891,11 +786,7 @@ paths:
891
786
  $ref: '#/components/responses/503'
892
787
  /parties/{Type}/{ID}/{SubId}/error:
893
788
  put:
894
- description: >-
895
- If the server is unable to find Party information of the provided
896
- identity, or another processing error occurred, the error callback `PUT
897
- /parties/{Type}/{ID}/error` (or `PUT
898
- /parties/{Type}/{ID}/{SubId}/error`) is used.
789
+ description: If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used.
899
790
  summary: Return party information error
900
791
  tags:
901
792
  - parties
@@ -942,10 +833,7 @@ paths:
942
833
  $ref: '#/components/responses/503'
943
834
  /transactionRequests:
944
835
  post:
945
- description: >-
946
- The HTTP request `POST /transactionRequests` is used to request the
947
- creation of a transaction request for the provided financial transaction
948
- in the server.
836
+ description: The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
949
837
  summary: Perform transaction request
950
838
  tags:
951
839
  - transactionRequests
@@ -1001,11 +889,7 @@ paths:
1001
889
  - $ref: '#/components/parameters/FSPIOP-URI'
1002
890
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
1003
891
  get:
1004
- description: >-
1005
- The HTTP request `GET /transactionRequests/{ID}` is used to get
1006
- information regarding a transaction request created or requested
1007
- earlier. The `{ID}` in the URI should contain the `transactionRequestId`
1008
- that was used for the creation of the transaction request.
892
+ description: The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request.
1009
893
  summary: Retrieve transaction request information
1010
894
  tags:
1011
895
  - transactionRequests
@@ -1032,12 +916,7 @@ paths:
1032
916
  '503':
1033
917
  $ref: '#/components/responses/503'
1034
918
  put:
1035
- description: >-
1036
- The callback `PUT /transactionRequests/{ID}` is used to inform the
1037
- client of a requested or created transaction request. The `{ID}` in the
1038
- URI should contain the `transactionRequestId` that was used for the
1039
- creation of the transaction request, or the `{ID}` that was used in the
1040
- `GET /transactionRequests/{ID}`.
919
+ description: The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
1041
920
  summary: Return transaction request information
1042
921
  tags:
1043
922
  - transactionRequests
@@ -1072,13 +951,7 @@ paths:
1072
951
  $ref: '#/components/responses/503'
1073
952
  /transactionRequests/{ID}/error:
1074
953
  put:
1075
- description: >-
1076
- If the server is unable to find or create a transaction request, or
1077
- another processing error occurs, the error callback `PUT
1078
- /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should
1079
- contain the `transactionRequestId` that was used for the creation of the
1080
- transaction request, or the `{ID}` that was used in the `GET
1081
- /transactionRequests/{ID}`.
954
+ description: If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
1082
955
  summary: Return transaction request information error
1083
956
  tags:
1084
957
  - transactionRequests
@@ -1123,9 +996,7 @@ paths:
1123
996
  $ref: '#/components/responses/503'
1124
997
  /quotes:
1125
998
  post:
1126
- description: >-
1127
- The HTTP request `POST /quotes` is used to request the creation of a
1128
- quote for the provided financial transaction in the server.
999
+ description: The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
1129
1000
  summary: Calculate quote
1130
1001
  tags:
1131
1002
  - quotes
@@ -1181,10 +1052,7 @@ paths:
1181
1052
  - $ref: '#/components/parameters/FSPIOP-URI'
1182
1053
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
1183
1054
  get:
1184
- description: >-
1185
- The HTTP request `GET /quotes/{ID}` is used to get information regarding
1186
- a quote created or requested earlier. The `{ID}` in the URI should
1187
- contain the `quoteId` that was used for the creation of the quote.
1055
+ description: The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote.
1188
1056
  summary: Retrieve quote information
1189
1057
  tags:
1190
1058
  - quotes
@@ -1211,11 +1079,7 @@ paths:
1211
1079
  '503':
1212
1080
  $ref: '#/components/responses/503'
1213
1081
  put:
1214
- description: >-
1215
- The callback `PUT /quotes/{ID}` is used to inform the client of a
1216
- requested or created quote. The `{ID}` in the URI should contain the
1217
- `quoteId` that was used for the creation of the quote, or the `{ID}`
1218
- that was used in the `GET /quotes/{ID}` request.
1082
+ description: The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
1219
1083
  summary: Return quote information
1220
1084
  tags:
1221
1085
  - quotes
@@ -1250,12 +1114,7 @@ paths:
1250
1114
  $ref: '#/components/responses/503'
1251
1115
  /quotes/{ID}/error:
1252
1116
  put:
1253
- description: >-
1254
- If the server is unable to find or create a quote, or some other
1255
- processing error occurs, the error callback `PUT /quotes/{ID}/error` is
1256
- used. The `{ID}` in the URI should contain the `quoteId` that was used
1257
- for the creation of the quote, or the `{ID}` that was used in the `GET
1258
- /quotes/{ID}` request.
1117
+ description: If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
1259
1118
  summary: Return quote information error
1260
1119
  tags:
1261
1120
  - quotes
@@ -1311,43 +1170,20 @@ paths:
1311
1170
  - $ref: '#/components/parameters/FSPIOP-URI'
1312
1171
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
1313
1172
  get:
1314
- description: >-
1315
- The HTTP request `GET /authorizations/{ID}` is used to request the Payer
1316
- to enter the applicable credentials in the Payee FSP system. The `{ID}`
1317
- in the URI should contain the `transactionRequestID`, received from the
1318
- `POST /transactionRequests` service earlier in the process. This request
1319
- requires a query string to be included in the URI, with the following
1320
- key-value pairs*:*
1321
-
1322
-
1323
- - `authenticationType={Type}`, where `{Type}` value is a valid
1324
- authentication type from the enumeration `AuthenticationType`.
1325
-
1326
-
1327
- - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of
1328
- retries left before the financial transaction is rejected.
1329
- `{NrOfRetries}` must be expressed in the form of the data type
1330
- `Integer`. `retriesLeft=1` means that this is the last retry before the
1331
- financial transaction is rejected.
1332
-
1333
-
1334
- - `amount={Amount}`, where `{Amount}` is the transaction amount that
1335
- will be withdrawn from the Payer’s account. `{Amount}` must be expressed
1336
- in the form of the data type `Amount`.
1173
+ description: |-
1174
+ The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
1337
1175
 
1176
+ - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
1338
1177
 
1339
- - `currency={Currency}`, where `{Currency}` is the transaction currency
1340
- for the amount that will be withdrawn from the Payer’s account. The
1341
- `{Currency}` value must be expressed in the form of the enumeration
1342
- `CurrencyCode`.
1178
+ - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected.
1343
1179
 
1180
+ - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`.
1344
1181
 
1345
- The following is an example URI containing all the required key-value
1346
- pairs in the query string*:*
1182
+ - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`.
1347
1183
 
1184
+ The following is an example URI containing all the required key-value pairs in the query string*:*
1348
1185
 
1349
- `GET
1350
- /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102&currency=USD`
1186
+ `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102&currency=USD`
1351
1187
  summary: Perform authorization
1352
1188
  tags:
1353
1189
  - authorizations
@@ -1374,11 +1210,7 @@ paths:
1374
1210
  '503':
1375
1211
  $ref: '#/components/responses/503'
1376
1212
  put:
1377
- description: >-
1378
- The callback `PUT /authorizations/{ID}` is used to inform the client of
1379
- the result of a previously-requested authorization. The `{ID}` in the
1380
- URI should contain the `{ID}` that was used in the `GET
1381
- /authorizations/{ID}` request.
1213
+ description: The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request.
1382
1214
  summary: Return authorization result
1383
1215
  tags:
1384
1216
  - authorizations
@@ -1413,11 +1245,7 @@ paths:
1413
1245
  $ref: '#/components/responses/503'
1414
1246
  /authorizations/{ID}/error:
1415
1247
  put:
1416
- description: >-
1417
- If the server is unable to find the transaction request, or another
1418
- processing error occurs, the error callback `PUT
1419
- /authorizations/{ID}/error` is used. The `{ID}` in the URI should
1420
- contain the `{ID}` that was used in the `GET /authorizations/{ID}`.
1248
+ description: If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`.
1421
1249
  summary: Return authorization error
1422
1250
  tags:
1423
1251
  - authorizations
@@ -1462,10 +1290,7 @@ paths:
1462
1290
  $ref: '#/components/responses/503'
1463
1291
  /transfers:
1464
1292
  post:
1465
- description: >-
1466
- The HTTP request `POST /transfers` is used to request the creation of a
1467
- transfer for the next ledger, and a financial transaction for the Payee
1468
- FSP.
1293
+ description: The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP.
1469
1294
  summary: Perform transfer
1470
1295
  tags:
1471
1296
  - transfers
@@ -1521,11 +1346,7 @@ paths:
1521
1346
  - $ref: '#/components/parameters/FSPIOP-URI'
1522
1347
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
1523
1348
  get:
1524
- description: >-
1525
- The HTTP request `GET /transfers/{ID}` is used to get information
1526
- regarding a transfer created or requested earlier. The `{ID}` in the URI
1527
- should contain the `transferId` that was used for the creation of the
1528
- transfer.
1349
+ description: The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer.
1529
1350
  summary: Retrieve transfer information
1530
1351
  tags:
1531
1352
  - transfers
@@ -1552,11 +1373,7 @@ paths:
1552
1373
  '503':
1553
1374
  $ref: '#/components/responses/503'
1554
1375
  put:
1555
- description: >-
1556
- The callback `PUT /transfers/{ID}` is used to inform the client of a
1557
- requested or created transfer. The `{ID}` in the URI should contain the
1558
- `transferId` that was used for the creation of the transfer, or the
1559
- `{ID}` that was used in the `GET /transfers/{ID}` request.
1376
+ description: The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request.
1560
1377
  summary: Return transfer information
1561
1378
  tags:
1562
1379
  - transfers
@@ -1591,12 +1408,7 @@ paths:
1591
1408
  $ref: '#/components/responses/503'
1592
1409
  /transfers/{ID}/error:
1593
1410
  put:
1594
- description: >-
1595
- If the server is unable to find or create a transfer, or another
1596
- processing error occurs, the error callback `PUT /transfers/{ID}/error`
1597
- is used. The `{ID}` in the URI should contain the `transferId` that was
1598
- used for the creation of the transfer, or the `{ID}` that was used in
1599
- the `GET /transfers/{ID}`.
1411
+ description: If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`.
1600
1412
  summary: Return transfer information error
1601
1413
  tags:
1602
1414
  - transfers
@@ -1652,12 +1464,7 @@ paths:
1652
1464
  - $ref: '#/components/parameters/FSPIOP-URI'
1653
1465
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
1654
1466
  get:
1655
- description: >-
1656
- The HTTP request `GET /transactions/{ID}` is used to get transaction
1657
- information regarding a financial transaction created earlier. The
1658
- `{ID}` in the URI should contain the `transactionId` that was used for
1659
- the creation of the quote, as the transaction is created as part of
1660
- another process (the transfer process).
1467
+ description: The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process).
1661
1468
  summary: Retrieve transaction information
1662
1469
  tags:
1663
1470
  - transactions
@@ -1684,10 +1491,7 @@ paths:
1684
1491
  '503':
1685
1492
  $ref: '#/components/responses/503'
1686
1493
  put:
1687
- description: >-
1688
- The callback `PUT /transactions/{ID}` is used to inform the client of a
1689
- requested transaction. The `{ID}` in the URI should contain the `{ID}`
1690
- that was used in the `GET /transactions/{ID}` request.
1494
+ description: The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
1691
1495
  summary: Return transaction information
1692
1496
  tags:
1693
1497
  - transactions
@@ -1722,11 +1526,7 @@ paths:
1722
1526
  $ref: '#/components/responses/503'
1723
1527
  /transactions/{ID}/error:
1724
1528
  put:
1725
- description: >-
1726
- If the server is unable to find or create a transaction, or another
1727
- processing error occurs, the error callback `PUT
1728
- /transactions/{ID}/error` is used. The `{ID}` in the URI should contain
1729
- the `{ID}` that was used in the `GET /transactions/{ID}` request.
1529
+ description: If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
1730
1530
  summary: Return transaction information error
1731
1531
  tags:
1732
1532
  - transactions
@@ -1771,9 +1571,7 @@ paths:
1771
1571
  $ref: '#/components/responses/503'
1772
1572
  /bulkQuotes:
1773
1573
  post:
1774
- description: >-
1775
- The HTTP request `POST /bulkQuotes` is used to request the creation of a
1776
- bulk quote for the provided financial transactions in the server.
1574
+ description: The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
1777
1575
  summary: Calculate bulk quote
1778
1576
  tags:
1779
1577
  - bulkQuotes
@@ -1829,11 +1627,7 @@ paths:
1829
1627
  - $ref: '#/components/parameters/FSPIOP-URI'
1830
1628
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
1831
1629
  get:
1832
- description: >-
1833
- The HTTP request `GET /bulkQuotes/{ID}` is used to get information
1834
- regarding a bulk quote created or requested earlier. The `{ID}` in the
1835
- URI should contain the `bulkQuoteId` that was used for the creation of
1836
- the bulk quote.
1630
+ description: The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
1837
1631
  summary: Retrieve bulk quote information
1838
1632
  tags:
1839
1633
  - bulkQuotes
@@ -1860,11 +1654,7 @@ paths:
1860
1654
  '503':
1861
1655
  $ref: '#/components/responses/503'
1862
1656
  put:
1863
- description: >-
1864
- The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a
1865
- requested or created bulk quote. The `{ID}` in the URI should contain
1866
- the `bulkQuoteId` that was used for the creation of the bulk quote, or
1867
- the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
1657
+ description: The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
1868
1658
  summary: Return bulk quote information
1869
1659
  tags:
1870
1660
  - bulkQuotes
@@ -1899,12 +1689,7 @@ paths:
1899
1689
  $ref: '#/components/responses/503'
1900
1690
  /bulkQuotes/{ID}/error:
1901
1691
  put:
1902
- description: >-
1903
- If the server is unable to find or create a bulk quote, or another
1904
- processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error`
1905
- is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was
1906
- used for the creation of the bulk quote, or the `{ID}` that was used in
1907
- the `GET /bulkQuotes/{ID}` request.
1692
+ description: If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
1908
1693
  summary: Return bulk quote information error
1909
1694
  tags:
1910
1695
  - bulkQuotes
@@ -1949,9 +1734,7 @@ paths:
1949
1734
  $ref: '#/components/responses/503'
1950
1735
  /bulkTransfers:
1951
1736
  post:
1952
- description: >-
1953
- The HTTP request `POST /bulkTransfers` is used to request the creation
1954
- of a bulk transfer in the server.
1737
+ description: The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
1955
1738
  summary: Perform bulk transfer
1956
1739
  tags:
1957
1740
  - bulkTransfers
@@ -2007,11 +1790,7 @@ paths:
2007
1790
  - $ref: '#/components/parameters/FSPIOP-URI'
2008
1791
  - $ref: '#/components/parameters/FSPIOP-HTTP-Method'
2009
1792
  get:
2010
- description: >-
2011
- The HTTP request `GET /bulkTransfers/{ID}` is used to get information
2012
- regarding a bulk transfer created or requested earlier. The `{ID}` in
2013
- the URI should contain the `bulkTransferId` that was used for the
2014
- creation of the bulk transfer.
1793
+ description: The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
2015
1794
  summary: Retrieve bulk transfer information
2016
1795
  tags:
2017
1796
  - bulkTransfers
@@ -2038,12 +1817,7 @@ paths:
2038
1817
  '503':
2039
1818
  $ref: '#/components/responses/503'
2040
1819
  put:
2041
- description: >-
2042
- The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a
2043
- requested or created bulk transfer. The `{ID}` in the URI should contain
2044
- the `bulkTransferId` that was used for the creation of the bulk transfer
2045
- (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET
2046
- /bulkTransfers/{ID}` request.
1820
+ description: The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
2047
1821
  summary: Return bulk transfer information
2048
1822
  tags:
2049
1823
  - bulkTransfers
@@ -2078,13 +1852,7 @@ paths:
2078
1852
  $ref: '#/components/responses/503'
2079
1853
  /bulkTransfers/{ID}/error:
2080
1854
  put:
2081
- description: >-
2082
- If the server is unable to find or create a bulk transfer, or another
2083
- processing error occurs, the error callback `PUT
2084
- /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain
2085
- the `bulkTransferId` that was used for the creation of the bulk transfer
2086
- (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET
2087
- /bulkTransfers/{ID}` request.
1855
+ description: If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
2088
1856
  summary: Return bulk transfer information error
2089
1857
  tags:
2090
1858
  - bulkTransfers
@@ -2133,27 +1901,17 @@ components:
2133
1901
  title: Amount
2134
1902
  type: string
2135
1903
  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2136
- description: >-
2137
- The API data type Amount is a JSON String in a canonical format that is
2138
- restricted by a regular expression for interoperability reasons. This
2139
- pattern does not allow any trailing zeroes at all, but allows an amount
2140
- without a minor currency unit. It also only allows four digits in the
2141
- minor currency unit; a negative value is not allowed. Using more than 18
2142
- digits in the major currency unit is not allowed.
1904
+ 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.
2143
1905
  AmountType:
2144
1906
  title: AmountType
2145
1907
  type: string
2146
1908
  enum:
2147
1909
  - SEND
2148
1910
  - RECEIVE
2149
- description: >-
1911
+ description: |-
2150
1912
  Below are the allowed values for the enumeration AmountType.
2151
-
2152
- - SEND - Amount the Payer would like to send, that is, the amount that
2153
- should be withdrawn from the Payer account including any fees.
2154
-
2155
- - RECEIVE - Amount the Payer would like the Payee to receive, that is,
2156
- the amount that should be sent to the receiver exclusive of any fees.
1913
+ - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
1914
+ - 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.
2157
1915
  AuthenticationInfo:
2158
1916
  title: AuthenticationInfo
2159
1917
  type: object
@@ -2184,10 +1942,7 @@ components:
2184
1942
  title: OtpValue
2185
1943
  type: string
2186
1944
  pattern: ^\d{3,10}$
2187
- description: >-
2188
- The API data type OtpValue is a JSON String of 3 to 10 characters,
2189
- consisting of digits only. Negative numbers are not allowed. One or more
2190
- leading zeros are allowed.
1945
+ 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.
2191
1946
  QRCODE:
2192
1947
  title: QRCODE
2193
1948
  type: string
@@ -2200,9 +1955,7 @@ components:
2200
1955
  - $ref: '#/components/schemas/OtpValue'
2201
1956
  - $ref: '#/components/schemas/QRCODE'
2202
1957
  pattern: ^\d{3,10}$|^\S{1,64}$
2203
- description: >-
2204
- Contains the authentication value. The format depends on the
2205
- authentication type used in the AuthenticationInfo complex type.
1958
+ description: Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
2206
1959
  AuthorizationResponse:
2207
1960
  title: AuthorizationResponse
2208
1961
  type: string
@@ -2219,28 +1972,15 @@ components:
2219
1972
  title: BalanceOfPayments
2220
1973
  type: string
2221
1974
  pattern: ^[1-9]\d{2}$
2222
- description: >-
2223
- (BopCode) The API data type
2224
- [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String
2225
- of 3 characters, consisting of digits only. Negative numbers are not
2226
- allowed. A leading zero is not allowed.
1975
+ 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.
2227
1976
  BinaryString:
2228
1977
  type: string
2229
1978
  pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
2230
- description: >-
2231
- The API data type BinaryString is a JSON String. The string is a
2232
- base64url encoding of a string of raw bytes, where padding (character
2233
- ‘=’) is added at the end of the data if needed to ensure that the string
2234
- is a multiple of 4 characters. The length restriction indicates the
2235
- allowed number of characters.
1979
+ 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.
2236
1980
  BinaryString32:
2237
1981
  type: string
2238
1982
  pattern: ^[A-Za-z0-9-_]{43}$
2239
- description: >-
2240
- The API data type BinaryString32 is a fixed size version of the API data
2241
- type BinaryString, where the raw underlying data is always of 32 bytes.
2242
- The data type BinaryString32 should not use a padding character as the
2243
- size of the underlying data is fixed.
1983
+ 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.
2244
1984
  BulkTransferState:
2245
1985
  title: BulkTransactionState
2246
1986
  type: string
@@ -2251,20 +1991,13 @@ components:
2251
1991
  - PROCESSING
2252
1992
  - COMPLETED
2253
1993
  - REJECTED
2254
- description: >-
1994
+ description: |-
2255
1995
  Below are the allowed values for the enumeration.
2256
-
2257
- - RECEIVED - Payee FSP has received the bulk transfer from the Payer
2258
- FSP.
2259
-
1996
+ - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
2260
1997
  - PENDING - Payee FSP has validated the bulk transfer.
2261
-
2262
1998
  - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
2263
-
2264
1999
  - PROCESSING - Payee FSP has started to transfer fund to the Payees.
2265
-
2266
2000
  - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
2267
-
2268
2001
  - REJECTED - Payee FSP has rejected to process the bulk transfer.
2269
2002
  Code:
2270
2003
  title: Code
@@ -2274,22 +2007,11 @@ components:
2274
2007
  CorrelationId:
2275
2008
  title: CorrelationId
2276
2009
  type: string
2277
- pattern: >-
2278
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2279
- description: >-
2280
- Identifier that correlates all messages of the same sequence. The API
2281
- data type UUID (Universally Unique Identifier) is a JSON String in
2282
- canonical format, conforming to [RFC
2283
- 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
2284
- regular expression for interoperability reasons. A UUID is always 36
2285
- characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
2010
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2011
+ 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 (‘-‘).
2286
2012
  Currency:
2287
2013
  title: Currency
2288
- description: >-
2289
- The currency codes defined in [ISO
2290
- 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
2291
- alphabetic codes are used as the standard naming representation for
2292
- currencies.
2014
+ 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.
2293
2015
  type: string
2294
2016
  minLength: 3
2295
2017
  maxLength: 3
@@ -2461,46 +2183,23 @@ components:
2461
2183
  Date:
2462
2184
  title: Date
2463
2185
  type: string
2464
- pattern: >-
2465
- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
2466
- description: >-
2467
- The API data type Date is a JSON String in a lexical format that is
2468
- restricted by a regular expression for interoperability reasons. This
2469
- format, as specified in ISO 8601, contains a date only. A more readable
2470
- version of the format is yyyy-MM-dd. Examples are "1982-05-23",
2471
- "1987-08-05”.
2186
+ pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
2187
+ 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”.
2472
2188
  DateOfBirth:
2473
2189
  title: DateofBirth (type Date)
2474
2190
  type: string
2475
- pattern: >-
2476
- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
2191
+ pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
2477
2192
  description: Date of Birth of the Party.
2478
2193
  DateTime:
2479
2194
  title: DateTime
2480
2195
  type: string
2481
- pattern: >-
2482
- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
2483
- description: >-
2484
- The API data type DateTime is a JSON String in a lexical format that is
2485
- restricted by a regular expression for interoperability reasons. The
2486
- format is according to [ISO
2487
- 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed
2488
- in a combined date, time and time zone format. A more readable version
2489
- of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
2490
- "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
2491
- indicates Zulu time zone, same as UTC).
2196
+ pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
2197
+ 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).
2492
2198
  ErrorCode:
2493
2199
  title: ErrorCode
2494
2200
  type: string
2495
2201
  pattern: ^[1-9]\d{3}$
2496
- description: >-
2497
- The API data type ErrorCode is a JSON String of four characters,
2498
- consisting of digits only. Negative numbers are not allowed. A leading
2499
- zero is not allowed. Each error code in the API is a four-digit number,
2500
- for example, 1234, where the first number (1 in the example) represents
2501
- the high-level error category, the second number (2 in the example)
2502
- represents the low-level error category, and the last two numbers (34 in
2503
- the example) represent the specific error.
2202
+ 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.
2504
2203
  ErrorDescription:
2505
2204
  title: ErrorDescription
2506
2205
  type: string
@@ -2524,9 +2223,7 @@ components:
2524
2223
  type: string
2525
2224
  minLength: 1
2526
2225
  maxLength: 128
2527
- pattern: >-
2528
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2529
- .,''-]{1,128}$
2226
+ pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
2530
2227
  description: First name of the Party (Name Type).
2531
2228
  FspId:
2532
2229
  title: FspId
@@ -2616,9 +2313,7 @@ components:
2616
2313
  description: Party Id type, id, sub ID or type, and FSP Id.
2617
2314
  merchantClassificationCode:
2618
2315
  type: string
2619
- description: >-
2620
- Used in the context of Payee Information, where the Payee happens to
2621
- be a merchant accepting merchant payments.
2316
+ description: Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments.
2622
2317
  example: 4321
2623
2318
  name:
2624
2319
  type: string
@@ -2626,9 +2321,7 @@ components:
2626
2321
  example: Henrik Karlsson
2627
2322
  personalInfo:
2628
2323
  $ref: '#/components/schemas/PartyPersonalInfo'
2629
- description: >-
2630
- Personal information used to verify identity of Party such as first,
2631
- middle, last name and date of birth.
2324
+ description: Personal information used to verify identity of Party such as first, middle, last name and date of birth.
2632
2325
  required:
2633
2326
  - partyIdInfo
2634
2327
  Refund:
@@ -2638,9 +2331,7 @@ components:
2638
2331
  properties:
2639
2332
  originalTransactionId:
2640
2333
  type: string
2641
- description: >-
2642
- Reference to the original transaction ID that is requested to be
2643
- refunded.
2334
+ description: Reference to the original transaction ID that is requested to be refunded.
2644
2335
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
2645
2336
  refundReason:
2646
2337
  type: string
@@ -2671,9 +2362,7 @@ components:
2671
2362
  example: CONSUMER
2672
2363
  refundInfo:
2673
2364
  $ref: '#/components/schemas/Refund'
2674
- description: >-
2675
- Extra information specific to a refund scenario. Should only be
2676
- populated if scenario is REFUND.
2365
+ description: Extra information specific to a refund scenario. Should only be populated if scenario is REFUND.
2677
2366
  balanceOfPayments:
2678
2367
  type: string
2679
2368
  description: Balance of Payments code.
@@ -2699,9 +2388,7 @@ components:
2699
2388
  ExtensionList:
2700
2389
  title: ExtensionList
2701
2390
  type: object
2702
- description: >-
2703
- Data model for the complex type ExtensionList. An optional list of
2704
- extensions, specific to deployment.
2391
+ description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2705
2392
  properties:
2706
2393
  extension:
2707
2394
  type: array
@@ -2773,71 +2460,46 @@ components:
2773
2460
  title: Integer
2774
2461
  type: string
2775
2462
  pattern: ^[1-9]\d*$
2776
- description: >-
2777
- The API data type Integer is a JSON String consisting of digits only.
2778
- Negative numbers and leading zeroes are not allowed. The data type is
2779
- always limited to a specific number of digits.
2463
+ 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.
2780
2464
  LastName:
2781
2465
  title: LastName
2782
2466
  type: string
2783
2467
  minLength: 1
2784
2468
  maxLength: 128
2785
- pattern: >-
2786
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2787
- .,''-]{1,128}$
2469
+ pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
2788
2470
  description: Last name of the Party (Name Type).
2789
2471
  Latitude:
2790
2472
  title: Latitude
2791
2473
  type: string
2792
- pattern: >-
2793
- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
2794
- description: >-
2795
- The API data type Latitude is a JSON String in a lexical format that is
2796
- restricted by a regular expression for interoperability reasons.
2474
+ pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
2475
+ description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2797
2476
  Longitude:
2798
2477
  title: Longitude
2799
2478
  type: string
2800
- pattern: >-
2801
- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
2802
- description: >-
2803
- The API data type Longitude is a JSON String in a lexical format that is
2804
- restricted by a regular expression for interoperability reasons.
2479
+ pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
2480
+ description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2805
2481
  MerchantClassificationCode:
2806
2482
  title: MerchantClassificationCode
2807
2483
  type: string
2808
2484
  pattern: ^[\d]{1,4}$
2809
- description: >-
2810
- A limited set of pre-defined numbers. This list would be a limited set
2811
- of numbers identifying a set of popular merchant types like School Fees,
2812
- Pubs and Restaurants, Groceries, etc.
2485
+ 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.
2813
2486
  MiddleName:
2814
2487
  title: MiddleName
2815
2488
  type: string
2816
2489
  minLength: 1
2817
2490
  maxLength: 128
2818
- pattern: >-
2819
- ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
2820
- .,''-]{1,128}$
2491
+ pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
2821
2492
  description: Middle name of the Party (Name Type).
2822
2493
  Name:
2823
2494
  title: Name
2824
2495
  type: string
2825
2496
  pattern: ^(?!\s*$)[\w .,'-]{1,128}$
2826
- description: >-
2827
- The API data type Name is a JSON String, restricted by a regular
2828
- expression to avoid characters which are generally not used in a name.
2829
-
2830
-
2831
- Regular Expression - The regular expression for restricting the Name
2832
- type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a
2833
- string consisting of whitespace only, all Unicode characters are
2834
- allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,)
2835
- and space characters ( ).
2497
+ description: |-
2498
+ 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.
2836
2499
 
2500
+ 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 ( ).
2837
2501
 
2838
- **Note:** In some programming languages, Unicode support must be
2839
- specifically enabled. For example, if Java is used, the flag
2840
- UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
2502
+ **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.
2841
2503
  Note:
2842
2504
  title: Note
2843
2505
  type: string
@@ -2862,52 +2524,16 @@ components:
2862
2524
  - ACCOUNT_ID
2863
2525
  - IBAN
2864
2526
  - ALIAS
2865
- description: >-
2527
+ description: |-
2866
2528
  Below are the allowed values for the enumeration.
2867
-
2868
- - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
2869
- Number, that is, the phone number) is used as reference to a
2870
- participant. The MSISDN identifier should be in international format
2871
- according to the [ITU-T E.164
2872
- standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
2873
- MSISDN may be prefixed by a single plus sign, indicating the
2874
- international prefix.
2875
-
2876
- - EMAIL - An email is used as reference to a participant. The format of
2877
- the email should be according to the informational [RFC
2878
- 3696](https://tools.ietf.org/html/rfc3696).
2879
-
2880
- - PERSONAL_ID - A personal identifier is used as reference to a
2881
- participant. Examples of personal identification are passport number,
2882
- birth certificate number, and national registration number. The
2883
- identifier number is added in the PartyIdentifier element. The personal
2884
- identifier type is added in the PartySubIdOrType element.
2885
-
2886
- - BUSINESS - A specific Business (for example, an organization or a
2887
- company) is used as reference to a participant. The BUSINESS identifier
2888
- can be in any format. To make a transaction connected to a specific
2889
- username or bill number in a Business, the PartySubIdOrType element
2890
- should be used.
2891
-
2892
- - DEVICE - A specific device (for example, a POS or ATM) ID connected to
2893
- a specific business or organization is used as reference to a Party. For
2894
- referencing a specific device under a specific business or organization,
2895
- use the PartySubIdOrType element.
2896
-
2897
- - ACCOUNT_ID - A bank account number or FSP account ID should be used as
2898
- reference to a participant. The ACCOUNT_ID identifier can be in any
2899
- format, as formats can greatly differ depending on country and FSP.
2900
-
2901
- - IBAN - A bank account number or FSP account ID is used as reference to
2902
- a participant. The IBAN identifier can consist of up to 34 alphanumeric
2903
- characters and should be entered without whitespace.
2904
-
2905
- - ALIAS An alias is used as reference to a participant. The alias should
2906
- be created in the FSP as an alternative reference to an account owner.
2907
- Another example of an alias is a username in the FSP system. The ALIAS
2908
- identifier can be in any format. It is also possible to use the
2909
- PartySubIdOrType element for identifying an account under an Alias
2910
- defined by the PartyIdentifier.
2529
+ - 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.
2530
+ - 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).
2531
+ - 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.
2532
+ - 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.
2533
+ - 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.
2534
+ - 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.
2535
+ - 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.
2536
+ - 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.
2911
2537
  PartyName:
2912
2538
  title: PartyName
2913
2539
  type: string
@@ -2919,9 +2545,7 @@ components:
2919
2545
  type: string
2920
2546
  minLength: 1
2921
2547
  maxLength: 128
2922
- description: >-
2923
- Either a sub-identifier of a PartyIdentifier, or a sub-type of the
2924
- PartyIdType, normally a PersonalIdentifierType.
2548
+ description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
2925
2549
  PersonalIdentifierType:
2926
2550
  title: PersonalIdentifierType
2927
2551
  type: string
@@ -2939,44 +2563,21 @@ components:
2939
2563
  - VOTERS_ID
2940
2564
  - UNITED_NATIONS
2941
2565
  - OTHER_ID
2942
- description: >-
2566
+ description: |-
2943
2567
  Below are the allowed values for the enumeration.
2944
-
2945
2568
  - PASSPORT - A passport number is used as reference to a Party.
2946
-
2947
- - NATIONAL_REGISTRATION - A national registration number is used as
2948
- reference to a Party.
2949
-
2569
+ - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party.
2950
2570
  - DRIVING_LICENSE - A driving license is used as reference to a Party.
2951
-
2952
- - ALIEN_REGISTRATION - An alien registration number is used as reference
2953
- to a Party.
2954
-
2955
- - NATIONAL_ID_CARD - A national ID card number is used as reference to a
2956
- Party.
2957
-
2958
- - EMPLOYER_ID - A tax identification number is used as reference to a
2959
- Party.
2960
-
2961
- - TAX_ID_NUMBER - A tax identification number is used as reference to a
2962
- Party.
2963
-
2964
- - SENIOR_CITIZENS_CARD - A senior citizens card number is used as
2965
- reference to a Party.
2966
-
2967
- - MARRIAGE_CERTIFICATE - A marriage certificate number is used as
2968
- reference to a Party.
2969
-
2571
+ - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party.
2572
+ - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party.
2573
+ - EMPLOYER_ID - A tax identification number is used as reference to a Party.
2574
+ - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
2575
+ - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
2576
+ - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
2970
2577
  - HEALTH_CARD - A health card number is used as reference to a Party.
2971
-
2972
- - VOTERS_ID - A voter’s identification number is used as reference to a
2973
- Party.
2974
-
2975
- - UNITED_NATIONS - An UN (United Nations) number is used as reference to
2976
- a Party.
2977
-
2978
- - OTHER_ID - Any other type of identification type number is used as
2979
- reference to a Party.
2578
+ - VOTERS_ID - A voter’s identification number is used as reference to a Party.
2579
+ - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
2580
+ - OTHER_ID - Any other type of identification type number is used as reference to a Party.
2980
2581
  RefundReason:
2981
2582
  title: RefundReason
2982
2583
  type: string
@@ -2987,10 +2588,7 @@ components:
2987
2588
  title: TokenCode
2988
2589
  type: string
2989
2590
  pattern: ^[0-9a-zA-Z]{4,32}$
2990
- description: >-
2991
- The API data type TokenCode is a JSON String between 4 and 32
2992
- characters, consisting of digits or upper- or lowercase characters from
2993
- a to z.
2591
+ 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.
2994
2592
  Money:
2995
2593
  title: Money
2996
2594
  type: object
@@ -3010,22 +2608,14 @@ components:
3010
2608
  Transaction:
3011
2609
  title: Transaction
3012
2610
  type: object
3013
- description: >-
3014
- Data model for the complex type Transaction. The Transaction type is
3015
- used to carry end-to-end data between the Payer FSP and the Payee FSP in
3016
- the ILP Packet. Both the transactionId and the quoteId in the data model
3017
- are decided by the Payer FSP in the POST /quotes request.
2611
+ 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.
3018
2612
  properties:
3019
2613
  transactionId:
3020
2614
  type: string
3021
- description: >-
3022
- ID of the transaction, the ID is decided by the Payer FSP during the
3023
- creation of the quote.
2615
+ description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
3024
2616
  quoteId:
3025
2617
  type: string
3026
- description: >-
3027
- ID of the quote, the ID is decided by the Payer FSP during the
3028
- creation of the quote.
2618
+ description: ID of the quote, the ID is decided by the Payer FSP during the creation of the quote.
3029
2619
  payee:
3030
2620
  $ref: '#/components/schemas/Party'
3031
2621
  description: Information about the Payee in the proposed financial transaction.
@@ -3057,17 +2647,10 @@ components:
3057
2647
  enum:
3058
2648
  - PAYER
3059
2649
  - PAYEE
3060
- description: >-
2650
+ description: |-
3061
2651
  Below are the allowed values for the enumeration.
3062
-
3063
- - PAYER - Sender of funds is initiating the transaction. The account to
3064
- send from is either owned by the Payer or is connected to the Payer in
3065
- some way.
3066
-
3067
- - PAYEE - Recipient of the funds is initiating the transaction by
3068
- sending a transaction request. The Payer must approve the transaction,
3069
- either automatically by a pre-generated OTP or by pre-approval of the
3070
- Payee, or by manually approving in his or her own Device.
2652
+ - 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.
2653
+ - 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.
3071
2654
  TransactionInitiatorType:
3072
2655
  title: TransactionInitiatorType
3073
2656
  type: string
@@ -3105,28 +2688,12 @@ components:
3105
2688
  - TRANSFER
3106
2689
  - PAYMENT
3107
2690
  - REFUND
3108
- description: >-
2691
+ description: |-
3109
2692
  Below are the allowed values for the enumeration.
3110
-
3111
- - DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a
3112
- normal scenario, electronic funds are transferred from a Business
3113
- account to a Consumer account, and physical cash is given from the
3114
- Consumer to the Business User.
3115
-
3116
- - WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction.
3117
- In a normal scenario, electronic funds are transferred from a Consumer’s
3118
- account to a Business account, and physical cash is given from the
3119
- Business User to the Consumer.
3120
-
3121
- - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to
3122
- Consumer) transaction.
3123
-
3124
- - PAYMENT - Usually used for performing a transaction from a Consumer to
3125
- a Merchant or Organization, but could also be for a B2B (Business to
3126
- Business) payment. The transaction could be online for a purchase in an
3127
- Internet store, in a physical store where both the Consumer and Business
3128
- User are present, a bill payment, a donation, and so on.
3129
-
2693
+ - 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.
2694
+ - 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.
2695
+ - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
2696
+ - 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.
3130
2697
  - REFUND - Used for performing a refund of transaction.
3131
2698
  TransactionState:
3132
2699
  title: TransactionState
@@ -3146,9 +2713,7 @@ components:
3146
2713
  title: TransactionSubScenario
3147
2714
  type: string
3148
2715
  pattern: ^[A-Z_]{1,32}$
3149
- description: >-
3150
- Possible sub-scenario, defined locally within the scheme (UndefinedEnum
3151
- Type).
2716
+ description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
3152
2717
  TransferState:
3153
2718
  title: TransferState
3154
2719
  type: string
@@ -3157,24 +2722,17 @@ components:
3157
2722
  - RESERVED
3158
2723
  - COMMITTED
3159
2724
  - ABORTED
3160
- description: >-
2725
+ description: |-
3161
2726
  Below are the allowed values for the enumeration.
3162
-
3163
2727
  - RECEIVED - Next ledger has received the transfer.
3164
-
3165
2728
  - RESERVED - Next ledger has reserved the transfer.
3166
-
3167
2729
  - COMMITTED - Next ledger has successfully performed the transfer.
3168
-
3169
- - ABORTED - Next ledger has aborted the transfer due to a rejection or
3170
- failure to perform the transfer.
2730
+ - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
3171
2731
  UndefinedEnum:
3172
2732
  title: UndefinedEnum
3173
2733
  type: string
3174
2734
  pattern: ^[A-Z_]{1,32}$
3175
- description: >-
3176
- The API data type UndefinedEnum is a JSON String consisting of 1 to 32
3177
- uppercase characters including an underscore character (_).
2735
+ description: The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_).
3178
2736
  ErrorInformation:
3179
2737
  title: ErrorInformation
3180
2738
  type: object
@@ -3196,18 +2754,14 @@ components:
3196
2754
  ErrorInformationResponse:
3197
2755
  title: ErrorInformationResponse
3198
2756
  type: object
3199
- description: >-
3200
- Data model for the complex type object that contains an optional element
3201
- ErrorInformation used along with 4xx and 5xx responses.
2757
+ description: Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
3202
2758
  properties:
3203
2759
  errorInformation:
3204
2760
  $ref: '#/components/schemas/ErrorInformation'
3205
2761
  ParticipantsTypeIDPutResponse:
3206
2762
  title: ParticipantsTypeIDPutResponse
3207
2763
  type: object
3208
- description: >-
3209
- The object sent in the PUT /participants/{Type}/{ID}/{SubId} and
3210
- /participants/{Type}/{ID} callbacks.
2764
+ description: The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks.
3211
2765
  properties:
3212
2766
  fspId:
3213
2767
  type: string
@@ -3216,9 +2770,7 @@ components:
3216
2770
  ParticipantsTypeIDSubIDPostRequest:
3217
2771
  title: ParticipantsTypeIDSubIDPostRequest
3218
2772
  type: object
3219
- description: >-
3220
- The object sent in the POST /participants/{Type}/{ID}/{SubId} and
3221
- /participants/{Type}/{ID} requests.
2773
+ description: The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests.
3222
2774
  properties:
3223
2775
  fspId:
3224
2776
  type: string
@@ -3246,9 +2798,7 @@ components:
3246
2798
  properties:
3247
2799
  requestId:
3248
2800
  type: string
3249
- description: >-
3250
- The ID of the request, decided by the client. Used for
3251
- identification of the callback from the server.
2801
+ description: The ID of the request, decided by the client. Used for identification of the callback from the server.
3252
2802
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3253
2803
  partyList:
3254
2804
  type: array
@@ -3256,14 +2806,10 @@ components:
3256
2806
  $ref: '#/components/schemas/PartyIdInfo'
3257
2807
  minItems: 1
3258
2808
  maxItems: 10000
3259
- description: >-
3260
- List of PartyIdInfo elements that the client would like to update or
3261
- create FSP information about.
2809
+ description: List of PartyIdInfo elements that the client would like to update or create FSP information about.
3262
2810
  currency:
3263
2811
  type: string
3264
- description: >-
3265
- Indicate that the provided Currency is supported by each PartyIdInfo
3266
- in the list.
2812
+ description: Indicate that the provided Currency is supported by each PartyIdInfo in the list.
3267
2813
  example: USD
3268
2814
  required:
3269
2815
  - requestId
@@ -3278,10 +2824,7 @@ components:
3278
2824
  description: Party Id type, id, sub ID or type, and FSP Id.
3279
2825
  errorInformation:
3280
2826
  $ref: '#/components/schemas/ErrorInformation'
3281
- description: >-
3282
- If the Party failed to be added, error information should be
3283
- provided. Otherwise, this parameter should be empty to indicate
3284
- success.
2827
+ description: If the Party failed to be added, error information should be provided. Otherwise, this parameter should be empty to indicate success.
3285
2828
  required:
3286
2829
  - partyId
3287
2830
  ParticipantsIDPutResponse:
@@ -3295,14 +2838,10 @@ components:
3295
2838
  $ref: '#/components/schemas/PartyResult'
3296
2839
  minItems: 1
3297
2840
  maxItems: 10000
3298
- description: >-
3299
- List of PartyResult elements that were either created or failed to
3300
- be created.
2841
+ description: List of PartyResult elements that were either created or failed to be created.
3301
2842
  currency:
3302
2843
  type: string
3303
- description: >-
3304
- Indicate that the provided Currency was set to be supported by each
3305
- successfully added PartyIdInfo.
2844
+ description: Indicate that the provided Currency was set to be supported by each successfully added PartyIdInfo.
3306
2845
  example: USD
3307
2846
  required:
3308
2847
  - partyList
@@ -3313,14 +2852,13 @@ components:
3313
2852
  properties:
3314
2853
  party:
3315
2854
  $ref: '#/components/schemas/Party'
2855
+ description: Information regarding the requested Party.
3316
2856
  required:
3317
2857
  - party
3318
2858
  GeoCode:
3319
2859
  title: GeoCode
3320
2860
  type: object
3321
- description: >-
3322
- Data model for the complex type GeoCode. Indicates the geographic
3323
- location from where the transaction was initiated.
2861
+ description: Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
3324
2862
  properties:
3325
2863
  latitude:
3326
2864
  type: string
@@ -3340,20 +2878,14 @@ components:
3340
2878
  properties:
3341
2879
  transactionRequestId:
3342
2880
  type: string
3343
- description: >-
3344
- Common ID between the FSPs for the transaction request object,
3345
- decided by the Payee FSP. The ID should be reused for resends of the
3346
- same transaction request. A new ID should be generated for each new
3347
- transaction request.
2881
+ description: Common ID between the FSPs for the transaction request object, decided by the Payee FSP. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request.
3348
2882
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3349
2883
  payee:
3350
2884
  $ref: '#/components/schemas/Party'
3351
2885
  description: Information about the Payee in the proposed financial transaction.
3352
2886
  payer:
3353
2887
  $ref: '#/components/schemas/PartyIdInfo'
3354
- description: >-
3355
- Information about the Payer type, id, sub-type/id, FSP Id in the
3356
- proposed financial transaction.
2888
+ description: Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.
3357
2889
  amount:
3358
2890
  $ref: '#/components/schemas/Money'
3359
2891
  description: Requested amount to be transferred from the Payer to Payee.
@@ -3366,19 +2898,14 @@ components:
3366
2898
  example: Free-text memo.
3367
2899
  geoCode:
3368
2900
  $ref: '#/components/schemas/GeoCode'
3369
- description: >-
3370
- Longitude and Latitude of the initiating Party. Can be used to
3371
- detect fraud.
2901
+ description: Longitude and Latitude of the initiating Party. Can be used to detect fraud.
3372
2902
  authenticationType:
3373
2903
  type: string
3374
2904
  description: OTP or QR Code, otherwise empty.
3375
2905
  example: OTP
3376
2906
  expiration:
3377
2907
  type: string
3378
- description: >-
3379
- Can be set to get a quick failure in case the peer FSP takes too
3380
- long to respond. Also, it may be beneficial for Consumer, Agent,
3381
- Merchant to know that their request has a time limit.
2908
+ description: Can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, Merchant to know that their request has a time limit.
3382
2909
  example: '2016-05-24T08:38:08.699-04:00'
3383
2910
  extensionList:
3384
2911
  $ref: '#/components/schemas/ExtensionList'
@@ -3396,9 +2923,7 @@ components:
3396
2923
  properties:
3397
2924
  transactionId:
3398
2925
  type: string
3399
- description: >-
3400
- Identifies a related transaction (if a transaction has been
3401
- created).
2926
+ description: Identifies a related transaction (if a transaction has been created).
3402
2927
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3403
2928
  transactionRequestState:
3404
2929
  type: string
@@ -3416,20 +2941,11 @@ components:
3416
2941
  properties:
3417
2942
  quoteId:
3418
2943
  type: string
3419
- description: >-
3420
- Common ID between the FSPs for the quote object, decided by the
3421
- Payer FSP. The ID should be reused for resends of the same quote for
3422
- a transaction. A new ID should be generated for each new quote for a
3423
- transaction.
2944
+ description: Common ID between the FSPs for the quote object, decided by the Payer FSP. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction.
3424
2945
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3425
2946
  transactionId:
3426
2947
  type: string
3427
- description: >-
3428
- Common ID (decided by the Payer FSP) between the FSPs for the future
3429
- transaction object. The actual transaction will be created as part
3430
- of a successful transfer process. The ID should be reused for
3431
- resends of the same quote for a transaction. A new ID should be
3432
- generated for each new quote for a transaction.
2948
+ description: Common ID (decided by the Payer FSP) between the FSPs for the future transaction object. The actual transaction will be created as part of a successful transfer process. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction.
3433
2949
  example: a8323bc6-c228-4df2-ae82-e5a997baf899
3434
2950
  transactionRequestId:
3435
2951
  type: string
@@ -3444,21 +2960,15 @@ components:
3444
2960
  properties:
3445
2961
  partyIdType:
3446
2962
  type: string
3447
- description: >-
3448
- Information about the Payer in the proposed financial
3449
- transaction. Type of the identifier.
2963
+ description: Information about the Payer in the proposed financial transaction. Type of the identifier.
3450
2964
  example: PERSONAL_ID
3451
2965
  partyIdentifier:
3452
2966
  type: string
3453
- description: >-
3454
- Information about the Payer in the proposed financial
3455
- transaction. An indentifier for the Party.
2967
+ description: Information about the Payer in the proposed financial transaction. An indentifier for the Party.
3456
2968
  example: 16135551212
3457
2969
  partySubIdOrType:
3458
2970
  type: string
3459
- description: >-
3460
- Information about the Payer in the proposed financial
3461
- transaction. A sub-identifier or sub-type for the Party.
2971
+ description: Information about the Payer in the proposed financial transaction. A sub-identifier or sub-type for the Party.
3462
2972
  example: PASSPORT
3463
2973
  fspId:
3464
2974
  type: string
@@ -3466,9 +2976,7 @@ components:
3466
2976
  example: 1234
3467
2977
  merchantClassificationCode:
3468
2978
  type: string
3469
- description: >-
3470
- Used in the context of Payee Information, where the Payee
3471
- happens to be a merchant accepting merchant payments.
2979
+ description: Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments.
3472
2980
  example: 1234
3473
2981
  name:
3474
2982
  type: string
@@ -3523,20 +3031,14 @@ components:
3523
3031
  description: Type of transaction for which the quote is requested.
3524
3032
  geoCode:
3525
3033
  $ref: '#/components/schemas/GeoCode'
3526
- description: >-
3527
- Longitude and Latitude of the initiating Party. Can be used to
3528
- detect fraud.
3034
+ description: Longitude and Latitude of the initiating Party. Can be used to detect fraud.
3529
3035
  note:
3530
3036
  type: string
3531
3037
  description: A memo that will be attached to the transaction.
3532
3038
  example: Free-text memo.
3533
3039
  expiration:
3534
3040
  type: string
3535
- description: >-
3536
- Expiration is optional. It can be set to get a quick failure in case
3537
- the peer FSP takes too long to respond. Also, it may be beneficial
3538
- for Consumer, Agent, and Merchant to know that their request has a
3539
- time limit.
3041
+ description: Expiration is optional. It can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, and Merchant to know that their request has a time limit.
3540
3042
  example: '2016-05-24T08:38:08.699-04:00'
3541
3043
  extensionList:
3542
3044
  $ref: '#/components/schemas/ExtensionList'
@@ -3596,9 +3098,7 @@ components:
3596
3098
  example: '0'
3597
3099
  expiration:
3598
3100
  type: string
3599
- description: >-
3600
- Date and time until when the quotation is valid and can be honored
3601
- when used in the subsequent transaction.
3101
+ description: Date and time until when the quotation is valid and can be honored when used in the subsequent transaction.
3602
3102
  example: '2016-05-24T08:38:08.699-04:00'
3603
3103
  geoCode:
3604
3104
  $ref: '#/components/schemas/GeoCode'
@@ -3606,8 +3106,7 @@ components:
3606
3106
  ilpPacket:
3607
3107
  type: string
3608
3108
  description: The ILP Packet that must be attached to the transfer by the Payer.
3609
- example: >-
3610
- “AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA”
3109
+ example: “AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA”
3611
3110
  condition:
3612
3111
  type: string
3613
3112
  description: The condition that must be attached to the transfer by the Payer.
@@ -3631,10 +3130,7 @@ components:
3631
3130
  example: OTP
3632
3131
  responseType:
3633
3132
  type: string
3634
- description: >-
3635
- Enum containing response information; if the customer entered the
3636
- authentication value, rejected the transaction, or requested a
3637
- resend of the authentication value.
3133
+ description: Enum containing response information; if the customer entered the authentication value, rejected the transaction, or requested a resend of the authentication value.
3638
3134
  example: ENTERED
3639
3135
  required:
3640
3136
  - responseType
@@ -3645,11 +3141,7 @@ components:
3645
3141
  properties:
3646
3142
  transferId:
3647
3143
  type: string
3648
- description: >-
3649
- The common ID between the FSPs and the optional Switch for the
3650
- transfer object, decided by the Payer FSP. The ID should be reused
3651
- for resends of the same transfer. A new ID should be generated for
3652
- each new transfer.
3144
+ description: The common ID between the FSPs and the optional Switch for the transfer object, decided by the Payer FSP. The ID should be reused for resends of the same transfer. A new ID should be generated for each new transfer.
3653
3145
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3654
3146
  payeeFsp:
3655
3147
  type: string
@@ -3664,21 +3156,15 @@ components:
3664
3156
  description: The transfer amount to be sent.
3665
3157
  ilpPacket:
3666
3158
  type: string
3667
- description: >-
3668
- The ILP Packet containing the amount delivered to the Payee and the
3669
- ILP Address of the Payee and any other end-to-end data.
3670
- example: >-
3671
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3159
+ description: The ILP Packet containing the amount delivered to the Payee and the ILP Address of the Payee and any other end-to-end data.
3160
+ example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3672
3161
  condition:
3673
3162
  type: string
3674
3163
  description: The condition that must be fulfilled to commit the transfer.
3675
3164
  example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
3676
3165
  expiration:
3677
3166
  type: string
3678
- description: >-
3679
- Expiration can be set to get a quick failure expiration of the
3680
- transfer. The transfer should be rolled back if no fulfilment is
3681
- delivered before this time.
3167
+ description: Expiration can be set to get a quick failure expiration of the transfer. The transfer should be rolled back if no fulfilment is delivered before this time.
3682
3168
  example: '2016-05-24T08:38:08.699-04:00'
3683
3169
  extensionList:
3684
3170
  $ref: '#/components/schemas/ExtensionList'
@@ -3698,9 +3184,7 @@ components:
3698
3184
  properties:
3699
3185
  fulfilment:
3700
3186
  type: string
3701
- description: >-
3702
- Fulfilment of the condition specified with the transaction.
3703
- Mandatory if transfer has completed successfully.
3187
+ description: Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.
3704
3188
  example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
3705
3189
  completedTimestamp:
3706
3190
  type: string
@@ -3730,9 +3214,7 @@ components:
3730
3214
  example: RECEIVED
3731
3215
  code:
3732
3216
  type: string
3733
- description: >-
3734
- Optional redemption information provided to Payer after transaction
3735
- has been completed.
3217
+ description: Optional redemption information provided to Payer after transaction has been completed.
3736
3218
  example: Test-Code
3737
3219
  extensionList:
3738
3220
  $ref: '#/components/schemas/ExtensionList'
@@ -3746,10 +3228,7 @@ components:
3746
3228
  properties:
3747
3229
  bulkQuoteId:
3748
3230
  type: string
3749
- description: >-
3750
- Common ID between the FSPs for the bulk quote object, decided by the
3751
- Payer FSP. The ID should be reused for resends of the same bulk
3752
- quote. A new ID should be generated for each new bulk quote.
3231
+ description: Common ID between the FSPs for the bulk quote object, decided by the Payer FSP. The ID should be reused for resends of the same bulk quote. A new ID should be generated for each new bulk quote.
3753
3232
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3754
3233
  payer:
3755
3234
  properties:
@@ -3758,9 +3237,7 @@ components:
3758
3237
  description: Party Id type, id, sub ID or type, and FSP Id.
3759
3238
  merchantClassificationCode:
3760
3239
  type: string
3761
- description: >-
3762
- Used in the context of Payee Information, where the Payee
3763
- happens to be a merchant accepting merchant payments.
3240
+ description: Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments.
3764
3241
  example: 1234
3765
3242
  name:
3766
3243
  type: string
@@ -3768,19 +3245,13 @@ components:
3768
3245
  example: Henrik Karlsson
3769
3246
  personalInfo:
3770
3247
  $ref: '#/components/schemas/PartyPersonalInfo'
3771
- description: >-
3772
- Personal information used to verify identity of Party such as
3773
- first, middle, last name and date of birth.
3248
+ description: Personal information used to verify identity of Party such as first, middle, last name and date of birth.
3774
3249
  geoCode:
3775
3250
  $ref: '#/components/schemas/GeoCode'
3776
- description: >-
3777
- Longitude and Latitude of the initiating Party. Can be used to
3778
- detect fraud.
3251
+ description: Longitude and Latitude of the initiating Party. Can be used to detect fraud.
3779
3252
  expiration:
3780
3253
  type: string
3781
- description: >-
3782
- Expiration is optional to let the Payee FSP know when a quote no
3783
- longer needs to be returned.
3254
+ description: Expiration is optional to let the Payee FSP know when a quote no longer needs to be returned.
3784
3255
  example: '2016-05-24T08:38:08.699-04:00'
3785
3256
  individualQuotes:
3786
3257
  properties:
@@ -3799,21 +3270,15 @@ components:
3799
3270
  description: Party Id type, id, sub ID or type, and FSP Id.
3800
3271
  merchantClassificationCode:
3801
3272
  type: string
3802
- description: >-
3803
- Used in the context of Payee Information, where the Payee
3804
- happens to be a merchant accepting merchant payments.
3273
+ description: Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments.
3805
3274
  example: 1234
3806
3275
  name:
3807
3276
  type: string
3808
- description: >-
3809
- Display name of the Party, could be a real name or a nick
3810
- name.
3277
+ description: Display name of the Party, could be a real name or a nick name.
3811
3278
  example: Henrik Karlsson
3812
3279
  personalInfo:
3813
3280
  $ref: '#/components/schemas/PartyPersonalInfo'
3814
- description: >-
3815
- Personal information used to verify identity of Party such
3816
- as first, middle, last name and date of birth.
3281
+ description: Personal information used to verify identity of Party such as first, middle, last name and date of birth.
3817
3282
  amountType:
3818
3283
  type: string
3819
3284
  description: SEND for sendAmount, RECEIVE for receiveAmount.
@@ -3907,18 +3372,14 @@ components:
3907
3372
  ilpPacket:
3908
3373
  type: string
3909
3374
  description: The ILP Packet that must be attached to the transfer by the Payer.
3910
- example: >-
3911
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3375
+ example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3912
3376
  condition:
3913
3377
  type: string
3914
3378
  description: The condition that must be attached to the transfer by the Payer.
3915
3379
  example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
3916
3380
  errorInformation:
3917
3381
  $ref: '#/components/schemas/ErrorInformation'
3918
- description: >-
3919
- Error code, category description. **Note:** receiveAmount,
3920
- payeeFspFee, payeeFspCommission, expiration, ilpPacket, condition
3921
- should not be set if errorInformation is set.
3382
+ description: Error code, category description. **Note:** receiveAmount, payeeFspFee, payeeFspCommission, expiration, ilpPacket, condition should not be set if errorInformation is set.
3922
3383
  extensionList:
3923
3384
  $ref: '#/components/schemas/ExtensionList'
3924
3385
  description: Optional extension, specific to deployment.
@@ -3934,14 +3395,10 @@ components:
3934
3395
  maxItems: 1000
3935
3396
  items:
3936
3397
  $ref: '#/components/schemas/IndividualQuoteResult'
3937
- description: >-
3938
- Fees for each individual transaction, if any of them are charged per
3939
- transaction.
3398
+ description: Fees for each individual transaction, if any of them are charged per transaction.
3940
3399
  expiration:
3941
3400
  type: string
3942
- description: >-
3943
- Date and time until when the quotation is valid and can be honored
3944
- when used in the subsequent transaction request.
3401
+ description: Date and time until when the quotation is valid and can be honored when used in the subsequent transaction request.
3945
3402
  example: '2016-05-24T08:38:08.699-04:00'
3946
3403
  extensionList:
3947
3404
  $ref: '#/components/schemas/ExtensionList'
@@ -3962,11 +3419,8 @@ components:
3962
3419
  description: Transaction amount to be sent.
3963
3420
  ilpPacket:
3964
3421
  type: string
3965
- description: >-
3966
- ILP Packet containing the amount delivered to the Payee and the ILP
3967
- Address of the Payee and any other end-to-end data.
3968
- example: >-
3969
- AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3422
+ description: ILP Packet containing the amount delivered to the Payee and the ILP Address of the Payee and any other end-to-end data.
3423
+ example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3970
3424
  condition:
3971
3425
  type: string
3972
3426
  description: Condition that must be fulfilled to commit the transfer.
@@ -3986,11 +3440,7 @@ components:
3986
3440
  properties:
3987
3441
  bulkTransferId:
3988
3442
  type: string
3989
- description: >-
3990
- Common ID between the FSPs and the optional Switch for the bulk
3991
- transfer object, decided by the Payer FSP. The ID should be reused
3992
- for resends of the same bulk transfer. A new ID should be generated
3993
- for each new bulk transfer.
3443
+ description: Common ID between the FSPs and the optional Switch for the bulk transfer object, decided by the Payer FSP. The ID should be reused for resends of the same bulk transfer. A new ID should be generated for each new bulk transfer.
3994
3444
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
3995
3445
  bulkQuoteId:
3996
3446
  type: string
@@ -4036,17 +3486,11 @@ components:
4036
3486
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
4037
3487
  fulfilment:
4038
3488
  type: string
4039
- description: >-
4040
- Fulfilment of the condition specified with the transaction.
4041
- **Note:** Either fulfilment or errorInformation should be set, not
4042
- both.
3489
+ description: Fulfilment of the condition specified with the transaction. **Note:** Either fulfilment or errorInformation should be set, not both.
4043
3490
  example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
4044
3491
  errorInformation:
4045
3492
  $ref: '#/components/schemas/ErrorInformation'
4046
- description: >-
4047
- If transfer is REJECTED, error information may be provided.
4048
- **Note:** Either fulfilment or errorInformation should be set, not
4049
- both.
3493
+ description: If transfer is REJECTED, error information may be provided. **Note:** Either fulfilment or errorInformation should be set, not both.
4050
3494
  extensionList:
4051
3495
  $ref: '#/components/schemas/ExtensionList'
4052
3496
  description: Optional extension, specific to deployment.
@@ -4097,9 +3541,7 @@ components:
4097
3541
  schema:
4098
3542
  type: string
4099
3543
  required: true
4100
- description: >-
4101
- The `Content-Type` header indicates the specific version of the API used
4102
- to send the payload body.
3544
+ description: The `Content-Type` header indicates the specific version of the API used to send the payload body.
4103
3545
  Date:
4104
3546
  name: Date
4105
3547
  in: header
@@ -4113,113 +3555,76 @@ components:
4113
3555
  schema:
4114
3556
  type: string
4115
3557
  required: false
4116
- description: >-
4117
- The `X-Forwarded-For` header field is an unofficially accepted standard
4118
- used for informational purposes of the originating client IP address, as
4119
- a request might pass multiple proxies, firewalls, and so on. Multiple
4120
- `X-Forwarded-For` values should be expected and supported by
4121
- implementers of the API.
4122
-
3558
+ description: |-
3559
+ 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.
4123
3560
 
4124
- **Note:** An alternative to `X-Forwarded-For` is defined in [RFC
4125
- 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC
4126
- 7239 is less-used and supported than `X-Forwarded-For`.
3561
+ **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`.
4127
3562
  FSPIOP-Source:
4128
3563
  name: FSPIOP-Source
4129
3564
  in: header
4130
3565
  schema:
4131
3566
  type: string
4132
3567
  required: true
4133
- description: >-
4134
- The `FSPIOP-Source` header field is a non-HTTP standard field used by
4135
- the API for identifying the sender of the HTTP request. The field should
4136
- be set by the original sender of the request. Required for routing and
4137
- signature verification (see header field `FSPIOP-Signature`).
3568
+ 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`).
4138
3569
  FSPIOP-Destination:
4139
3570
  name: FSPIOP-Destination
4140
3571
  in: header
4141
3572
  schema:
4142
3573
  type: string
4143
3574
  required: false
4144
- description: >-
4145
- The `FSPIOP-Destination` header field is a non-HTTP standard field used
4146
- by the API for HTTP header based routing of requests and responses to
4147
- the destination. The field should be set by the original sender of the
4148
- request (if known), so that any entities between the client and the
4149
- server do not need to parse the payload for routing purposes.
3575
+ 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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.
4150
3576
  FSPIOP-Encryption:
4151
3577
  name: FSPIOP-Encryption
4152
3578
  in: header
4153
3579
  schema:
4154
3580
  type: string
4155
3581
  required: false
4156
- description: >-
4157
- The `FSPIOP-Encryption` header field is a non-HTTP standard field used
4158
- by the API for applying end-to-end encryption of the request.
3582
+ 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.
4159
3583
  FSPIOP-Signature:
4160
3584
  name: FSPIOP-Signature
4161
3585
  in: header
4162
3586
  schema:
4163
3587
  type: string
4164
3588
  required: false
4165
- description: >-
4166
- The `FSPIOP-Signature` header field is a non-HTTP standard field used by
4167
- the API for applying an end-to-end request signature.
3589
+ description: The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.
4168
3590
  FSPIOP-URI:
4169
3591
  name: FSPIOP-URI
4170
3592
  in: header
4171
3593
  schema:
4172
3594
  type: string
4173
3595
  required: false
4174
- description: >-
4175
- The `FSPIOP-URI` header field is a non-HTTP standard field used by the
4176
- API for signature verification, should contain the service URI. Required
4177
- if signature verification is used, for more information, see [the API
4178
- Signature
4179
- document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
3596
+ 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).
4180
3597
  FSPIOP-HTTP-Method:
4181
3598
  name: FSPIOP-HTTP-Method
4182
3599
  in: header
4183
3600
  schema:
4184
3601
  type: string
4185
3602
  required: false
4186
- description: >-
4187
- The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used
4188
- by the API for signature verification, should contain the service HTTP
4189
- method. Required if signature verification is used, for more
4190
- information, see [the API Signature
4191
- document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
3603
+ 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).
4192
3604
  Accept:
4193
3605
  name: Accept
4194
3606
  in: header
4195
3607
  required: true
4196
3608
  schema:
4197
3609
  type: string
4198
- description: >-
4199
- The `Accept` header field indicates the version of the API the client
4200
- would like the server to use.
3610
+ description: The `Accept` header field indicates the version of the API the client would like the server to use.
4201
3611
  Content-Length:
4202
3612
  name: Content-Length
4203
3613
  in: header
4204
3614
  required: false
4205
3615
  schema:
4206
3616
  type: integer
4207
- description: >-
4208
- The `Content-Length` header field indicates the anticipated size of the
4209
- payload body. Only sent if there is a body.
4210
-
3617
+ description: |-
3618
+ The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
4211
3619
 
4212
- **Note:** The API supports a maximum size of 5242880 bytes (5
4213
- Megabytes).
3620
+ **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
4214
3621
  SubId:
4215
3622
  name: SubId
4216
3623
  in: path
4217
3624
  required: true
4218
3625
  schema:
4219
3626
  type: string
4220
- description: >-
4221
- A sub-identifier of the party identifier, or a sub-type of the party
4222
- identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
3627
+ description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
4223
3628
  responses:
4224
3629
  '200':
4225
3630
  description: OK
@@ -4318,17 +3723,12 @@ components:
4318
3723
  required: false
4319
3724
  schema:
4320
3725
  type: integer
4321
- description: >-
4322
- The `Content-Length` header field indicates the anticipated size of the
4323
- payload body. Only sent if there is a body.
4324
-
3726
+ description: |-
3727
+ The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
4325
3728
 
4326
- **Note:** The API supports a maximum size of 5242880 bytes (5
4327
- Megabytes).
3729
+ **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
4328
3730
  Content-Type:
4329
3731
  schema:
4330
3732
  type: string
4331
3733
  required: true
4332
- description: >-
4333
- The `Content-Type` header indicates the specific version of the API used
4334
- to send the payload body.
3734
+ description: The `Content-Type` header indicates the specific version of the API used to send the payload body.