@mojaloop/api-snippets 13.0.7 → 13.0.10

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 (233) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/CODEOWNERS +1 -1
  3. package/docs/thirdparty-openapi3-snippets.yaml +15 -1
  4. package/lib/thirdparty/openapi.d.ts +10 -2
  5. package/package.json +4 -4
  6. package/thirdparty/v1_0/openapi3/components/headers/Content-Length.yaml +1 -0
  7. package/thirdparty/v1_0/openapi3/components/headers/Content-Type.yaml +1 -0
  8. package/thirdparty/v1_0/openapi3/components/parameters/Accept.yaml +1 -0
  9. package/thirdparty/v1_0/openapi3/components/parameters/Content-Length.yaml +1 -0
  10. package/thirdparty/v1_0/openapi3/components/parameters/Content-Type.yaml +1 -0
  11. package/thirdparty/v1_0/openapi3/components/parameters/Date.yaml +1 -0
  12. package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-Destination.yaml +1 -0
  13. package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-Encryption.yaml +1 -0
  14. package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -0
  15. package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-Signature.yaml +1 -0
  16. package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-Source.yaml +1 -0
  17. package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-URI.yaml +1 -0
  18. package/thirdparty/v1_0/openapi3/components/parameters/ID.yaml +1 -0
  19. package/thirdparty/{openapi3 → v1_0/openapi3}/components/parameters/ServiceType.yaml +0 -0
  20. package/thirdparty/v1_0/openapi3/components/parameters/SubId.yaml +1 -0
  21. package/thirdparty/v1_0/openapi3/components/parameters/Type.yaml +1 -0
  22. package/thirdparty/v1_0/openapi3/components/parameters/X-Forwarded-For.yaml +1 -0
  23. package/thirdparty/v1_0/openapi3/components/responses/200.yaml +1 -0
  24. package/thirdparty/v1_0/openapi3/components/responses/202.yaml +1 -0
  25. package/thirdparty/v1_0/openapi3/components/responses/400.yaml +1 -0
  26. package/thirdparty/v1_0/openapi3/components/responses/401.yaml +1 -0
  27. package/thirdparty/v1_0/openapi3/components/responses/403.yaml +1 -0
  28. package/thirdparty/v1_0/openapi3/components/responses/404.yaml +1 -0
  29. package/thirdparty/v1_0/openapi3/components/responses/405.yaml +1 -0
  30. package/thirdparty/v1_0/openapi3/components/responses/406.yaml +1 -0
  31. package/thirdparty/v1_0/openapi3/components/responses/501.yaml +1 -0
  32. package/thirdparty/v1_0/openapi3/components/responses/503.yaml +1 -0
  33. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Account.yaml +0 -0
  34. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AccountAddress.yaml +0 -0
  35. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AccountList.yaml +0 -0
  36. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AccountsIDPutResponse.yaml +1 -1
  37. package/thirdparty/v1_0/openapi3/components/schemas/Amount.yaml +1 -0
  38. package/thirdparty/v1_0/openapi3/components/schemas/AmountType.yaml +1 -0
  39. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthenticationResponse.yaml +0 -0
  40. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthenticatorAssertionResponse.yaml +0 -0
  41. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthenticatorAttestationResponse.yaml +0 -0
  42. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthorizationResponseType.yaml +0 -0
  43. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthorizationResponseTypeAccepted.yaml +0 -0
  44. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthorizationResponseTypeRejected.yaml +0 -0
  45. package/thirdparty/v1_0/openapi3/components/schemas/BinaryString.yaml +1 -0
  46. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestChannelType.yaml +0 -0
  47. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestChannelTypeOTP.yaml +0 -0
  48. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestChannelTypeWeb.yaml +0 -0
  49. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestsIDPatchRequest.yaml +0 -0
  50. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestsIDPutResponseOTP.yaml +0 -0
  51. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestsIDPutResponseWeb.yaml +0 -0
  52. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestsPostRequest.yaml +0 -0
  53. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentStatus.yaml +0 -0
  54. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentStatusIssued.yaml +0 -0
  55. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentStatusRevoked.yaml +0 -0
  56. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsIDPatchResponseRevoked.yaml +0 -0
  57. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsIDPatchResponseVerified.yaml +0 -0
  58. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsIDPutResponseSigned.yaml +0 -0
  59. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsIDPutResponseVerified.yaml +0 -0
  60. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsPostRequestAUTH.yaml +0 -0
  61. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsPostRequestPISP.yaml +0 -0
  62. package/thirdparty/v1_0/openapi3/components/schemas/CorrelationId.yaml +1 -0
  63. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/CredentialStatusPending.yaml +0 -0
  64. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/CredentialStatusVerified.yaml +0 -0
  65. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/CredentialType.yaml +0 -0
  66. package/thirdparty/v1_0/openapi3/components/schemas/Currency.yaml +1 -0
  67. package/thirdparty/v1_0/openapi3/components/schemas/DateOfBirth.yaml +1 -0
  68. package/thirdparty/v1_0/openapi3/components/schemas/DateTime.yaml +1 -0
  69. package/thirdparty/v1_0/openapi3/components/schemas/ErrorCode.yaml +1 -0
  70. package/thirdparty/v1_0/openapi3/components/schemas/ErrorDescription.yaml +1 -0
  71. package/thirdparty/v1_0/openapi3/components/schemas/ErrorInformation.yaml +1 -0
  72. package/thirdparty/v1_0/openapi3/components/schemas/Extension.yaml +1 -0
  73. package/thirdparty/v1_0/openapi3/components/schemas/ExtensionKey.yaml +1 -0
  74. package/thirdparty/v1_0/openapi3/components/schemas/ExtensionList.yaml +1 -0
  75. package/thirdparty/v1_0/openapi3/components/schemas/ExtensionValue.yaml +1 -0
  76. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +0 -0
  77. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/FIDOPublicKeyCredentialAttestation.yaml +0 -0
  78. package/thirdparty/v1_0/openapi3/components/schemas/FirstName.yaml +1 -0
  79. package/thirdparty/v1_0/openapi3/components/schemas/FspId.yaml +1 -0
  80. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/GenericCredential.yaml +0 -0
  81. package/thirdparty/v1_0/openapi3/components/schemas/GeoCode.yaml +1 -0
  82. package/thirdparty/v1_0/openapi3/components/schemas/IlpCondition.yaml +1 -0
  83. package/thirdparty/v1_0/openapi3/components/schemas/IlpFulfilment.yaml +1 -0
  84. package/thirdparty/v1_0/openapi3/components/schemas/IlpPacket.yaml +1 -0
  85. package/thirdparty/v1_0/openapi3/components/schemas/Integer.yaml +1 -0
  86. package/thirdparty/v1_0/openapi3/components/schemas/LastName.yaml +1 -0
  87. package/thirdparty/v1_0/openapi3/components/schemas/Latitude.yaml +1 -0
  88. package/thirdparty/v1_0/openapi3/components/schemas/Longitude.yaml +1 -0
  89. package/thirdparty/v1_0/openapi3/components/schemas/MerchantClassificationCode.yaml +1 -0
  90. package/thirdparty/v1_0/openapi3/components/schemas/MiddleName.yaml +1 -0
  91. package/thirdparty/v1_0/openapi3/components/schemas/Money.yaml +1 -0
  92. package/thirdparty/v1_0/openapi3/components/schemas/Name.yaml +1 -0
  93. package/thirdparty/v1_0/openapi3/components/schemas/Note.yaml +1 -0
  94. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ParticipantsIDPutResponse.yaml +0 -0
  95. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ParticipantsPostRequest.yaml +0 -0
  96. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ParticipantsTypeIDPutResponse.yaml +0 -0
  97. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml +0 -0
  98. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartiesTypeIDPutResponse.yaml +0 -0
  99. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Party.yaml +0 -0
  100. package/thirdparty/v1_0/openapi3/components/schemas/PartyComplexName.yaml +1 -0
  101. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyIdInfo.yaml +0 -0
  102. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyIdInfoTPLink.yaml +0 -0
  103. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyIdType.yaml +0 -0
  104. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyIdTypeTPLink.yaml +0 -0
  105. package/thirdparty/v1_0/openapi3/components/schemas/PartyIdentifier.yaml +1 -0
  106. package/thirdparty/v1_0/openapi3/components/schemas/PartyName.yaml +1 -0
  107. package/thirdparty/v1_0/openapi3/components/schemas/PartyPersonalInfo.yaml +1 -0
  108. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyResult.yaml +0 -0
  109. package/thirdparty/v1_0/openapi3/components/schemas/PartySubIdOrType.yaml +1 -0
  110. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyTPLink.yaml +0 -0
  111. package/thirdparty/v1_0/openapi3/components/schemas/QuotesIDPutResponse.yaml +1 -0
  112. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/QuotesPostRequest.yaml +0 -0
  113. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Scope.yaml +0 -0
  114. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ScopeAction.yaml +0 -0
  115. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ServiceType.yaml +0 -0
  116. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ServicesServiceTypePutResponse.yaml +0 -0
  117. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedCredential.yaml +0 -0
  118. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadFIDO.yaml +0 -0
  119. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadGeneric.yaml +0 -0
  120. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadType.yaml +0 -0
  121. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadTypeFIDO.yaml +0 -0
  122. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadTypeGeneric.yaml +0 -0
  123. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseFIDO.yaml +0 -0
  124. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseGeneric.yaml +0 -0
  125. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseRejected.yaml +0 -0
  126. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsAuthorizationsPostRequest.yaml +1 -1
  127. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse.yaml +0 -0
  128. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml +2 -0
  129. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml +0 -0
  130. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse.yaml +0 -0
  131. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsVerificationsPostRequestFIDO.yaml +0 -0
  132. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsVerificationsPostRequestGeneric.yaml +0 -0
  133. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Transaction.yaml +0 -0
  134. package/thirdparty/v1_0/openapi3/components/schemas/TransactionRequestState.yaml +1 -0
  135. package/thirdparty/v1_0/openapi3/components/schemas/TransactionState.yaml +1 -0
  136. package/thirdparty/v1_0/openapi3/components/schemas/TransactionType.yaml +1 -0
  137. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Uri.yaml +0 -0
  138. package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/VerifiedCredential.yaml +0 -0
  139. package/thirdparty/{openapi3 → v1_0/openapi3}/openapi.yaml +0 -0
  140. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/accounts_ID.yaml +0 -0
  141. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/accounts_ID_error.yaml +1 -1
  142. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consentRequests.yaml +0 -0
  143. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consentRequests_ID.yaml +0 -0
  144. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consentRequests_ID_error.yaml +1 -1
  145. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consents.yaml +0 -0
  146. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consents_ID.yaml +0 -0
  147. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consents_ID_error.yaml +1 -1
  148. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/health.yaml +0 -0
  149. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/metrics.yaml +0 -0
  150. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants.yaml +0 -0
  151. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_ID.yaml +0 -0
  152. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_ID_error.yaml +1 -1
  153. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_Type_ID.yaml +0 -0
  154. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_Type_ID_error.yaml +1 -1
  155. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/services_ServiceType.yaml +0 -0
  156. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/services_ServiceType_error.yaml +1 -1
  157. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_authorizations.yaml +0 -0
  158. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_authorizations_ID.yaml +0 -0
  159. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_authorizations_ID_error.yaml +1 -1
  160. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_transactions.yaml +0 -0
  161. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_transactions_ID.yaml +0 -0
  162. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_transactions_ID_error.yaml +1 -1
  163. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_verifications.yaml +0 -0
  164. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_verifications_ID.yaml +0 -0
  165. package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_verifications_ID_error.yaml +1 -1
  166. package/thirdparty/{openapi3 → v1_0/openapi3}/thirdparty-dfsp-api.template.yaml +0 -0
  167. package/thirdparty/{openapi3 → v1_0/openapi3}/thirdparty-dfsp-api.yaml +443 -347
  168. package/thirdparty/{openapi3 → v1_0/openapi3}/thirdparty-pisp-api.template.yaml +7 -7
  169. package/thirdparty/{openapi3 → v1_0/openapi3}/thirdparty-pisp-api.yaml +435 -342
  170. package/thirdparty/openapi3/components/headers/Content-Length.yaml +0 -1
  171. package/thirdparty/openapi3/components/headers/Content-Type.yaml +0 -1
  172. package/thirdparty/openapi3/components/parameters/Accept.yaml +0 -1
  173. package/thirdparty/openapi3/components/parameters/Content-Length.yaml +0 -1
  174. package/thirdparty/openapi3/components/parameters/Content-Type.yaml +0 -1
  175. package/thirdparty/openapi3/components/parameters/Date.yaml +0 -1
  176. package/thirdparty/openapi3/components/parameters/FSPIOP-Destination.yaml +0 -1
  177. package/thirdparty/openapi3/components/parameters/FSPIOP-Encryption.yaml +0 -1
  178. package/thirdparty/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +0 -1
  179. package/thirdparty/openapi3/components/parameters/FSPIOP-Signature.yaml +0 -1
  180. package/thirdparty/openapi3/components/parameters/FSPIOP-Source.yaml +0 -1
  181. package/thirdparty/openapi3/components/parameters/FSPIOP-URI.yaml +0 -1
  182. package/thirdparty/openapi3/components/parameters/ID.yaml +0 -1
  183. package/thirdparty/openapi3/components/parameters/SubId.yaml +0 -1
  184. package/thirdparty/openapi3/components/parameters/Type.yaml +0 -1
  185. package/thirdparty/openapi3/components/parameters/X-Forwarded-For.yaml +0 -1
  186. package/thirdparty/openapi3/components/responses/200.yaml +0 -1
  187. package/thirdparty/openapi3/components/responses/202.yaml +0 -1
  188. package/thirdparty/openapi3/components/responses/400.yaml +0 -1
  189. package/thirdparty/openapi3/components/responses/401.yaml +0 -1
  190. package/thirdparty/openapi3/components/responses/403.yaml +0 -1
  191. package/thirdparty/openapi3/components/responses/404.yaml +0 -1
  192. package/thirdparty/openapi3/components/responses/405.yaml +0 -1
  193. package/thirdparty/openapi3/components/responses/406.yaml +0 -1
  194. package/thirdparty/openapi3/components/responses/501.yaml +0 -1
  195. package/thirdparty/openapi3/components/responses/503.yaml +0 -1
  196. package/thirdparty/openapi3/components/schemas/Amount.yaml +0 -1
  197. package/thirdparty/openapi3/components/schemas/AmountType.yaml +0 -1
  198. package/thirdparty/openapi3/components/schemas/BinaryString.yaml +0 -1
  199. package/thirdparty/openapi3/components/schemas/CorrelationId.yaml +0 -1
  200. package/thirdparty/openapi3/components/schemas/Currency.yaml +0 -1
  201. package/thirdparty/openapi3/components/schemas/DateOfBirth.yaml +0 -1
  202. package/thirdparty/openapi3/components/schemas/DateTime.yaml +0 -1
  203. package/thirdparty/openapi3/components/schemas/ErrorCode.yaml +0 -1
  204. package/thirdparty/openapi3/components/schemas/ErrorDescription.yaml +0 -1
  205. package/thirdparty/openapi3/components/schemas/ErrorInformation.yaml +0 -1
  206. package/thirdparty/openapi3/components/schemas/Extension.yaml +0 -1
  207. package/thirdparty/openapi3/components/schemas/ExtensionKey.yaml +0 -1
  208. package/thirdparty/openapi3/components/schemas/ExtensionList.yaml +0 -1
  209. package/thirdparty/openapi3/components/schemas/ExtensionValue.yaml +0 -1
  210. package/thirdparty/openapi3/components/schemas/FirstName.yaml +0 -1
  211. package/thirdparty/openapi3/components/schemas/FspId.yaml +0 -1
  212. package/thirdparty/openapi3/components/schemas/GeoCode.yaml +0 -1
  213. package/thirdparty/openapi3/components/schemas/IlpCondition.yaml +0 -1
  214. package/thirdparty/openapi3/components/schemas/IlpFulfilment.yaml +0 -1
  215. package/thirdparty/openapi3/components/schemas/IlpPacket.yaml +0 -1
  216. package/thirdparty/openapi3/components/schemas/Integer.yaml +0 -1
  217. package/thirdparty/openapi3/components/schemas/LastName.yaml +0 -1
  218. package/thirdparty/openapi3/components/schemas/Latitude.yaml +0 -1
  219. package/thirdparty/openapi3/components/schemas/Longitude.yaml +0 -1
  220. package/thirdparty/openapi3/components/schemas/MerchantClassificationCode.yaml +0 -1
  221. package/thirdparty/openapi3/components/schemas/MiddleName.yaml +0 -1
  222. package/thirdparty/openapi3/components/schemas/Money.yaml +0 -1
  223. package/thirdparty/openapi3/components/schemas/Name.yaml +0 -1
  224. package/thirdparty/openapi3/components/schemas/Note.yaml +0 -1
  225. package/thirdparty/openapi3/components/schemas/PartyComplexName.yaml +0 -1
  226. package/thirdparty/openapi3/components/schemas/PartyIdentifier.yaml +0 -1
  227. package/thirdparty/openapi3/components/schemas/PartyName.yaml +0 -1
  228. package/thirdparty/openapi3/components/schemas/PartyPersonalInfo.yaml +0 -1
  229. package/thirdparty/openapi3/components/schemas/PartySubIdOrType.yaml +0 -1
  230. package/thirdparty/openapi3/components/schemas/QuotesIDPutResponse.yaml +0 -1
  231. package/thirdparty/openapi3/components/schemas/TransactionRequestState.yaml +0 -1
  232. package/thirdparty/openapi3/components/schemas/TransactionState.yaml +0 -1
  233. package/thirdparty/openapi3/components/schemas/TransactionType.yaml +0 -1
@@ -3,8 +3,8 @@ info:
3
3
  title: Mojaloop Third Party API (PISP)
4
4
  version: '1.0'
5
5
  description: |
6
- A Mojaloop API for Payment Initiation Service Providers (PISPs) to perform Third Party functions on DFSPs' User's accounts.
7
- DFSPs who want to enable Payment Initiation Service Providers (PISPs) should implement the accompanying API - Mojaloop Third Party API (DFSP) instead.
6
+ A Mojaloop API for Payment Initiation Service Providers (PISPs) to perform Third Party functions on DFSPs' User's accounts.
7
+ DFSPs who want to enable Payment Initiation Service Providers (PISPs) should implement the accompanying API - Mojaloop Third Party API (DFSP) instead.
8
8
  license:
9
9
  name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
10
10
  url: 'https://github.com/mojaloop/mojaloop-specification/blob/master/LICENSE.md'
@@ -69,15 +69,24 @@ paths:
69
69
  schema:
70
70
  title: AccountsIDPutResponse
71
71
  type: object
72
- description: 'The object sent in a `PUT /accounts/{ID}` request.'
72
+ description: |-
73
+ Callback and data model information for GET /accounts/{ID}:
74
+ Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body
75
+ The PUT /accounts/{ID} response is used to inform the requester of the result of a request for accounts information. The identifier ID given in the call are the values given in the original request.
76
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
73
77
  properties:
74
78
  accountList:
75
- description: Information about the accounts that the DFSP associates with the identifier sent by the PISP
79
+ title: AccountList
76
80
  type: array
81
+ description: |-
82
+ The AccountList data model is used to hold information about the accounts that a party controls.
83
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
77
84
  items:
78
85
  title: Account
79
86
  type: object
80
- description: Data model for the complex type Account.
87
+ description: |-
88
+ Data model for the complex type Account.
89
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
81
90
  properties:
82
91
  accountNickname:
83
92
  title: Name
@@ -90,182 +99,17 @@ paths:
90
99
 
91
100
  **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.
92
101
  address:
93
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items/address'
102
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items/properties/address'
94
103
  currency:
95
- title: Currency
96
- 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.'
97
- type: string
98
- minLength: 3
99
- maxLength: 3
100
- enum:
101
- - AED
102
- - AFN
103
- - ALL
104
- - AMD
105
- - ANG
106
- - AOA
107
- - ARS
108
- - AUD
109
- - AWG
110
- - AZN
111
- - BAM
112
- - BBD
113
- - BDT
114
- - BGN
115
- - BHD
116
- - BIF
117
- - BMD
118
- - BND
119
- - BOB
120
- - BRL
121
- - BSD
122
- - BTN
123
- - BWP
124
- - BYN
125
- - BZD
126
- - CAD
127
- - CDF
128
- - CHF
129
- - CLP
130
- - CNY
131
- - COP
132
- - CRC
133
- - CUC
134
- - CUP
135
- - CVE
136
- - CZK
137
- - DJF
138
- - DKK
139
- - DOP
140
- - DZD
141
- - EGP
142
- - ERN
143
- - ETB
144
- - EUR
145
- - FJD
146
- - FKP
147
- - GBP
148
- - GEL
149
- - GGP
150
- - GHS
151
- - GIP
152
- - GMD
153
- - GNF
154
- - GTQ
155
- - GYD
156
- - HKD
157
- - HNL
158
- - HRK
159
- - HTG
160
- - HUF
161
- - IDR
162
- - ILS
163
- - IMP
164
- - INR
165
- - IQD
166
- - IRR
167
- - ISK
168
- - JEP
169
- - JMD
170
- - JOD
171
- - JPY
172
- - KES
173
- - KGS
174
- - KHR
175
- - KMF
176
- - KPW
177
- - KRW
178
- - KWD
179
- - KYD
180
- - KZT
181
- - LAK
182
- - LBP
183
- - LKR
184
- - LRD
185
- - LSL
186
- - LYD
187
- - MAD
188
- - MDL
189
- - MGA
190
- - MKD
191
- - MMK
192
- - MNT
193
- - MOP
194
- - MRO
195
- - MUR
196
- - MVR
197
- - MWK
198
- - MXN
199
- - MYR
200
- - MZN
201
- - NAD
202
- - NGN
203
- - NIO
204
- - NOK
205
- - NPR
206
- - NZD
207
- - OMR
208
- - PAB
209
- - PEN
210
- - PGK
211
- - PHP
212
- - PKR
213
- - PLN
214
- - PYG
215
- - QAR
216
- - RON
217
- - RSD
218
- - RUB
219
- - RWF
220
- - SAR
221
- - SBD
222
- - SCR
223
- - SDG
224
- - SEK
225
- - SGD
226
- - SHP
227
- - SLL
228
- - SOS
229
- - SPL
230
- - SRD
231
- - STD
232
- - SVC
233
- - SYP
234
- - SZL
235
- - THB
236
- - TJS
237
- - TMT
238
- - TND
239
- - TOP
240
- - TRY
241
- - TTD
242
- - TVD
243
- - TWD
244
- - TZS
245
- - UAH
246
- - UGX
247
- - USD
248
- - UYU
249
- - UZS
250
- - VEF
251
- - VND
252
- - VUV
253
- - WST
254
- - XAF
255
- - XCD
256
- - XDR
257
- - XOF
258
- - XPF
259
- - XTS
260
- - XXX
261
- - YER
262
- - ZAR
263
- - ZMW
264
- - ZWD
104
+ $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/amount/allOf/0/properties/currency'
265
105
  required:
266
106
  - accountNickname
267
- - id
107
+ - address
268
108
  - currency
109
+ minItems: 1
110
+ maxItems: 256
111
+ extensionList:
112
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
269
113
  required:
270
114
  - accounts
271
115
  example:
@@ -344,7 +188,7 @@ paths:
344
188
  maxLength: 128
345
189
  description: Error description string.
346
190
  extensionList:
347
- $ref: '#/paths/~1thirdpartyRequests~1authorizations/post/requestBody/content/application~1json/schema/extensionList'
191
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
348
192
  required:
349
193
  - errorCode
350
194
  - errorDescription
@@ -400,7 +244,12 @@ paths:
400
244
  schema:
401
245
  title: ConsentRequestsPostRequest
402
246
  type: object
403
- description: The object sent in a `POST /consentRequests` request.
247
+ description: |-
248
+ Used by: PISP
249
+ The HTTP request POST /consentRequests is used to request a DFSP to grant access to one or more accounts owned by a customer of the DFSP for the PISP who sends the request.
250
+ Callback and data model for POST /consentRequests:
251
+ Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url
252
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
404
253
  properties:
405
254
  consentRequestId:
406
255
  title: CorrelationId
@@ -420,13 +269,20 @@ paths:
420
269
  items:
421
270
  title: Scope
422
271
  type: object
423
- description: Scope + Account Identifier mapping for a Consent.
272
+ description: |-
273
+ The Scope element contains an identifier defining, in the terms of a DFSP, an account on which access types can be requested or granted. It also defines the access types which are requested or granted.
274
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
424
275
  properties:
425
276
  address:
426
277
  title: AccountAddress
427
278
  type: string
428
- description: |
429
- An address which can be used to identify the account.
279
+ description: |-
280
+ The AccountAddress data type is a variable length string with a maximum size of 1023 characters and consists of:
281
+ Alphanumeric characters, upper or lower case. (Addresses are case-sensitive so that they can contain data encoded in formats such as base64url.)
282
+ - Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character
283
+ An entity providing accounts to parties (i.e. a participant) can provide any value for an AccountAddress that is meaningful to that entity. It does not need to provide an address that makes the account identifiable outside the entity's domain.
284
+ IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case).
285
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
430
286
  pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
431
287
  minLength: 1
432
288
  maxLength: 1023
@@ -437,16 +293,18 @@ paths:
437
293
  items:
438
294
  title: ScopeAction
439
295
  type: string
296
+ description: |
297
+ The ScopeAction element contains an access type which a PISP can request
298
+ from a DFSP, or which a DFSP can grant to a PISP.
299
+ It must be a member of the appropriate enumeration.
300
+
301
+ - ACCOUNTS_GET_BALANCE: PISP can request a balance for the linked account
302
+ - ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the linked account in the DFSP
303
+ - ACCOUNTS_STATEMENT: PISP can request a statement of individual transactions on a user's account
440
304
  enum:
441
305
  - ACCOUNTS_GET_BALANCE
442
306
  - ACCOUNTS_TRANSFER
443
307
  - ACCOUNTS_STATEMENT
444
- description: |
445
- The permissions allowed on a given account by a DFSP as defined in
446
- a consent object
447
- - ACCOUNTS_GET_BALANCE: PISP can request a balance for the linked account
448
- - ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the linked account in the DFSP
449
- - ACCOUNTS_STATEMENT: PISP can request a statement of individual transactions on a user’s account
450
308
  required:
451
309
  - address
452
310
  - actions
@@ -461,9 +319,9 @@ paths:
461
319
  - WEB
462
320
  - OTP
463
321
  description: |
464
- The auth channel being used for the consentRequest.
465
- - "WEB" - The Web auth channel.
466
- - "OTP" - The OTP auth channel.
322
+ The auth channel being used for the consent request.
323
+ - WEB - DFSP can support authorization via a web-based login.
324
+ - OTP - DFSP can support authorization via a One Time PIN.
467
325
  callbackUri:
468
326
  title: Uri
469
327
  type: string
@@ -472,6 +330,38 @@ paths:
472
330
  maxLength: 512
473
331
  description: |
474
332
  The API data type Uri is a JSON string in a canonical format that is restricted by a regular expression for interoperability reasons.
333
+ extensionList:
334
+ title: ExtensionList
335
+ type: object
336
+ description: 'Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.'
337
+ properties:
338
+ extension:
339
+ type: array
340
+ items:
341
+ title: Extension
342
+ type: object
343
+ description: Data model for the complex type Extension.
344
+ properties:
345
+ key:
346
+ title: ExtensionKey
347
+ type: string
348
+ minLength: 1
349
+ maxLength: 32
350
+ description: Extension key.
351
+ value:
352
+ title: ExtensionValue
353
+ type: string
354
+ minLength: 1
355
+ maxLength: 128
356
+ description: Extension value.
357
+ required:
358
+ - key
359
+ - value
360
+ minItems: 1
361
+ maxItems: 16
362
+ description: Number of Extension elements.
363
+ required:
364
+ - extension
475
365
  required:
476
366
  - consentRequestId
477
367
  - userId
@@ -579,7 +469,7 @@ paths:
579
469
  minLength: 1
580
470
  maxLength: 256
581
471
  items:
582
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
472
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
583
473
  authChannels:
584
474
  type: array
585
475
  minLength: 1
@@ -590,11 +480,13 @@ paths:
590
480
  enum:
591
481
  - WEB
592
482
  description: |
593
- The web auth channel being used for PUT consentRequest/{ID} request.
483
+ The web auth channel being used for `PUT /consentRequest/{ID}` request.
594
484
  callbackUri:
595
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/callbackUri'
485
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/callbackUri'
596
486
  authUri:
597
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/callbackUri'
487
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/callbackUri'
488
+ extensionList:
489
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
598
490
  required:
599
491
  - scopes
600
492
  - authChannels
@@ -613,7 +505,7 @@ paths:
613
505
  minLength: 1
614
506
  maxLength: 256
615
507
  items:
616
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
508
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
617
509
  authChannels:
618
510
  type: array
619
511
  minLength: 1
@@ -624,9 +516,11 @@ paths:
624
516
  enum:
625
517
  - OTP
626
518
  description: |
627
- The OTP auth channel being used for PUT consentRequest/{ID} request.
519
+ The OTP auth channel being used for `PUT /consentRequests/{ID}` request.
628
520
  callbackUri:
629
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/callbackUri'
521
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/callbackUri'
522
+ extensionList:
523
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
630
524
  required:
631
525
  - scopes
632
526
  - authChannels
@@ -668,12 +562,17 @@ paths:
668
562
  schema:
669
563
  title: ConsentRequestsIDPatchRequest
670
564
  type: object
671
- description: 'The object sent in a `PATCH /consentRequests/{ID}` request.'
565
+ description: |-
566
+ Used by: PISP
567
+ After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
568
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
672
569
  properties:
673
570
  authToken:
674
571
  type: string
675
572
  pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
676
573
  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.'
574
+ extensionList:
575
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
677
576
  required:
678
577
  - authToken
679
578
  responses:
@@ -778,19 +677,21 @@ paths:
778
677
  properties:
779
678
  consentId:
780
679
  allOf:
781
- - $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
680
+ - $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
782
681
  description: |
783
682
  Common ID between the PISP and FSP for the Consent object
784
683
  determined by the DFSP who creates the Consent.
684
+ consentRequestId:
685
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
785
686
  scopes:
786
687
  minLength: 1
787
688
  maxLength: 256
788
689
  type: array
789
690
  items:
790
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
691
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
791
692
  credential:
792
693
  allOf:
793
- - $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/credential'
694
+ - $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/credential'
794
695
  status:
795
696
  title: ConsentStatus
796
697
  type: string
@@ -801,6 +702,8 @@ paths:
801
702
  Allowed values for the enumeration ConsentStatus
802
703
  - ISSUED - The consent has been issued by the DFSP
803
704
  - REVOKED - The consent has been revoked
705
+ extensionList:
706
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
804
707
  required:
805
708
  - consentId
806
709
  - scopes
@@ -814,14 +717,14 @@ paths:
814
717
  properties:
815
718
  consentId:
816
719
  allOf:
817
- - $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
720
+ - $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
818
721
  description: |
819
722
  Common ID between the PISP and the Payer DFSP for the consent object. The ID
820
- should be reused for resends of the same consent. A new ID should be generated
723
+ should be reused for re-sends of the same consent. A new ID should be generated
821
724
  for each new consent.
822
725
  consentRequestId:
823
726
  allOf:
824
- - $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
727
+ - $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
825
728
  description: |
826
729
  The ID given to the original consent request on which this consent is based.
827
730
  scopes:
@@ -829,9 +732,11 @@ paths:
829
732
  minLength: 1
830
733
  maxLength: 256
831
734
  items:
832
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
735
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
833
736
  status:
834
- $ref: '#/paths/~1consents/post/requestBody/content/application~1json/schema/oneOf/0/status'
737
+ $ref: '#/paths/~1consents/post/requestBody/content/application~1json/schema/oneOf/0/properties/status'
738
+ extensionList:
739
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
835
740
  required:
836
741
  - consentId
837
742
  - consentRequestId
@@ -870,7 +775,7 @@ paths:
870
775
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/10'
871
776
  get:
872
777
  description: |
873
- The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created.
778
+ The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created.
874
779
  tags:
875
780
  - consents
876
781
  operationId: GetConsent
@@ -924,7 +829,7 @@ paths:
924
829
  description: |
925
830
  PATCH /consents/{ID} request object.
926
831
 
927
- Sent by the DFSP to the PISP when a consent is verified.
832
+ Sent by the DFSP to the PISP when a consent is issued and verified.
928
833
  Used in the "Register Credential" part of the Account linking flow.
929
834
  type: object
930
835
  properties:
@@ -932,7 +837,7 @@ paths:
932
837
  type: object
933
838
  properties:
934
839
  status:
935
- title: CredentialStatus
840
+ title: CredentialStatusVerified
936
841
  type: string
937
842
  enum:
938
843
  - VERIFIED
@@ -941,6 +846,8 @@ paths:
941
846
  - "VERIFIED" - The Credential is valid and verified.
942
847
  required:
943
848
  - status
849
+ extensionList:
850
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
944
851
  required:
945
852
  - credential
946
853
  - title: ConsentsIDPatchResponseRevoked
@@ -952,7 +859,7 @@ paths:
952
859
  type: object
953
860
  properties:
954
861
  status:
955
- title: ConsentStatus
862
+ title: ConsentStatusRevoked
956
863
  type: string
957
864
  enum:
958
865
  - REVOKED
@@ -960,7 +867,9 @@ paths:
960
867
  Allowed values for the enumeration ConsentStatus
961
868
  - REVOKED - The consent has been revoked
962
869
  revokedAt:
963
- $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/completedTimestamp'
870
+ $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/completedTimestamp'
871
+ extensionList:
872
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
964
873
  required:
965
874
  - status
966
875
  - revokedAt
@@ -1009,18 +918,18 @@ paths:
1009
918
  The HTTP request `PUT /consents/{ID}` is used by the PISP to update a Consent with a signed challenge and register a credential.
1010
919
  Called by a `PISP` to after signing a challenge. Sent to a DFSP for verification.
1011
920
  properties:
1012
- scopes:
1013
- type: array
1014
- items:
1015
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
1016
921
  status:
1017
- title: ConsentStatus
922
+ title: ConsentStatusIssued
1018
923
  type: string
1019
924
  enum:
1020
925
  - ISSUED
1021
926
  description: |-
1022
927
  Allowed values for the enumeration ConsentStatus
1023
928
  - ISSUED - The consent has been issued by the DFSP
929
+ scopes:
930
+ type: array
931
+ items:
932
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
1024
933
  credential:
1025
934
  title: SignedCredential
1026
935
  type: object
@@ -1038,12 +947,11 @@ paths:
1038
947
  enum:
1039
948
  - FIDO
1040
949
  - GENERIC
1041
- description: |
1042
- The type of the Credential.
1043
- - "FIDO" - A FIDO public/private keypair
1044
- - "GENERIC" - A Generic public/private keypair
950
+ description: |-
951
+ The type of the Credential. - "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object. - "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object.
952
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
1045
953
  status:
1046
- title: CredentialStatus
954
+ title: CredentialStatusPending
1047
955
  type: string
1048
956
  enum:
1049
957
  - PENDING
@@ -1054,61 +962,21 @@ paths:
1054
962
  title: GenericCredential
1055
963
  type: object
1056
964
  description: |
1057
- A publicKey + signature of a challenge for a generic public/private keypair
965
+ A publicKey + signature of a challenge for a generic public/private keypair.
1058
966
  properties:
1059
967
  publicKey:
1060
- $ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/authToken'
968
+ $ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/authToken'
1061
969
  signature:
1062
- $ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/authToken'
970
+ $ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/authToken'
1063
971
  required:
1064
972
  - publicKey
1065
973
  - signature
1066
974
  additionalProperties: false
1067
975
  fidoPayload:
1068
- $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/1/credential/payload'
1069
- required:
1070
- - credentialType
1071
- - status
1072
- additionalProperties: false
1073
- required:
1074
- - scopes
1075
- - credential
1076
- additionalProperties: false
1077
- - title: ConsentsIDPutResponseVerified
1078
- type: object
1079
- description: |
1080
- The HTTP request `PUT /consents/{ID}` is used by the DFSP or Auth-Service to update a Consent object once it has been Verified.
1081
- Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
1082
- properties:
1083
- scopes:
1084
- type: array
1085
- items:
1086
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
1087
- status:
1088
- $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/status'
1089
- credential:
1090
- title: VerifiedCredential
1091
- type: object
1092
- description: |
1093
- A credential used to allow a user to prove their identity and access
1094
- to an account with a DFSP.
1095
-
1096
- VerifiedCredential is a special formatting of the credential to allow us to be
1097
- more explicit about the `status` field - it should only ever be VERIFIED when
1098
- updating a credential.
1099
- properties:
1100
- credentialType:
1101
- $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/credential/credentialType'
1102
- status:
1103
- type: string
1104
- enum:
1105
- - VERIFIED
1106
- description: 'The Credential is valid, and ready to be used by the PISP.'
1107
- payload:
1108
976
  title: FIDOPublicKeyCredentialAttestation
1109
977
  type: object
1110
978
  description: |
1111
- A data model representing a FIDO Attestation result. Derived from
979
+ A data model representing a FIDO Attestation result. Derived from
1112
980
  [`PublicKeyCredential` Interface](https://w3c.github.io/webauthn/#iface-pkcredential).
1113
981
 
1114
982
  The `PublicKeyCredential` interface represents the below fields with
@@ -1162,8 +1030,50 @@ paths:
1162
1030
  required:
1163
1031
  - credentialType
1164
1032
  - status
1165
- - payload
1166
1033
  additionalProperties: false
1034
+ extensionList:
1035
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
1036
+ required:
1037
+ - scopes
1038
+ - credential
1039
+ additionalProperties: false
1040
+ - title: ConsentsIDPutResponseVerified
1041
+ type: object
1042
+ description: |
1043
+ The HTTP request `PUT /consents/{ID}` is used by the DFSP or Auth-Service to update a Consent object once it has been Verified.
1044
+ Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
1045
+ properties:
1046
+ status:
1047
+ $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/status'
1048
+ scopes:
1049
+ type: array
1050
+ items:
1051
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
1052
+ credential:
1053
+ title: VerifiedCredential
1054
+ type: object
1055
+ description: |
1056
+ A credential used to allow a user to prove their identity and access
1057
+ to an account with a DFSP.
1058
+
1059
+ VerifiedCredential is a special formatting of Credential to allow us to be
1060
+ more explicit about the `status` field - it should only ever be VERIFIED when
1061
+ updating a credential.
1062
+ properties:
1063
+ credentialType:
1064
+ $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/credential/properties/credentialType'
1065
+ status:
1066
+ $ref: '#/paths/~1consents~1%7BID%7D/patch/requestBody/content/application~1json/schema/oneOf/0/properties/credential/properties/status'
1067
+ genericPayload:
1068
+ $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/credential/properties/genericPayload'
1069
+ fidoPayload:
1070
+ $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/credential/properties/fidoPayload'
1071
+ required:
1072
+ - credentialType
1073
+ - status
1074
+ additionalProperties: false
1075
+ extensionList:
1076
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
1167
1077
  required:
1168
1078
  - scopes
1169
1079
  - credential
@@ -1298,35 +1208,40 @@ paths:
1298
1208
  application/json:
1299
1209
  schema:
1300
1210
  title: ThirdpartyRequestsAuthorizationsPostRequest
1301
- description: POST /thirdpartyRequests/authorizations request object.
1211
+ description: |-
1212
+ Used by: DFSP
1213
+ The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request.
1214
+ Callback and data model information for POST /thirdpartyRequests/authorizations:
1215
+ Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url
1216
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
1302
1217
  type: object
1303
1218
  properties:
1304
1219
  authorizationRequestId:
1305
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
1220
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
1306
1221
  transactionRequestId:
1307
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
1222
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
1308
1223
  challenge:
1309
1224
  type: string
1310
1225
  description: The challenge that the PISP's client is to sign
1311
1226
  transferAmount:
1312
1227
  allOf:
1313
- - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/amount/allOf/0'
1314
- description: The amount that will be debited from the sending customers account as a consequence of the transaction.
1228
+ - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/amount/allOf/0'
1229
+ description: The amount that will be debited from the sending customer's account as a consequence of the transaction.
1315
1230
  payeeReceiveAmount:
1316
1231
  allOf:
1317
- - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/amount/allOf/0'
1318
- description: The amount that will be credited to the receiving customers account as a consequence of the transaction.
1232
+ - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/amount/allOf/0'
1233
+ description: The amount that will be credited to the receiving customer's account as a consequence of the transaction.
1319
1234
  fees:
1320
1235
  allOf:
1321
- - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/amount/allOf/0'
1236
+ - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/amount/allOf/0'
1322
1237
  description: The amount of fees that the paying customer will be charged as part of the transaction.
1323
1238
  payer:
1324
1239
  allOf:
1325
- - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/payer/allOf/0'
1240
+ - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payer/allOf/0'
1326
1241
  description: 'Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.'
1327
1242
  payee:
1328
1243
  allOf:
1329
- - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/payee/allOf/0'
1244
+ - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payee/allOf/0'
1330
1245
  description: Information about the Payee in the proposed financial transaction.
1331
1246
  transactionType:
1332
1247
  title: TransactionType
@@ -1388,7 +1303,7 @@ paths:
1388
1303
  description: Data model for the complex type Refund.
1389
1304
  properties:
1390
1305
  originalTransactionId:
1391
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
1306
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
1392
1307
  refundReason:
1393
1308
  title: RefundReason
1394
1309
  type: string
@@ -1410,40 +1325,10 @@ paths:
1410
1325
  - initiatorType
1411
1326
  expiration:
1412
1327
  allOf:
1413
- - $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/completedTimestamp'
1328
+ - $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/completedTimestamp'
1414
1329
  description: 'The time by which the transfer must be completed, set by the payee DFSP.'
1415
1330
  extensionList:
1416
- title: ExtensionList
1417
- type: object
1418
- description: 'Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.'
1419
- properties:
1420
- extension:
1421
- type: array
1422
- items:
1423
- title: Extension
1424
- type: object
1425
- description: Data model for the complex type Extension.
1426
- properties:
1427
- key:
1428
- title: ExtensionKey
1429
- type: string
1430
- minLength: 1
1431
- maxLength: 32
1432
- description: Extension key.
1433
- value:
1434
- title: ExtensionValue
1435
- type: string
1436
- minLength: 1
1437
- maxLength: 128
1438
- description: Extension value.
1439
- required:
1440
- - key
1441
- - value
1442
- minItems: 1
1443
- maxItems: 16
1444
- description: Number of Extension elements.
1445
- required:
1446
- - extension
1331
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
1447
1332
  required:
1448
1333
  - authorizationRequestId
1449
1334
  - transactionRequestId
@@ -1537,17 +1422,19 @@ paths:
1537
1422
  application/json:
1538
1423
  schema:
1539
1424
  oneOf:
1540
- - title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
1425
+ - title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
1541
1426
  type: object
1542
1427
  description: 'The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.'
1543
1428
  properties:
1544
1429
  responseType:
1545
- title: AuthorizationResponseType
1430
+ title: AuthorizationResponseTypeRejected
1546
1431
  description: |
1547
1432
  The customer rejected the terms of the transfer.
1548
1433
  type: string
1549
1434
  enum:
1550
1435
  - REJECTED
1436
+ extensionList:
1437
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
1551
1438
  required:
1552
1439
  - responseType
1553
1440
  - title: ThirdpartyRequestsAuthorizationsIDPutResponseFIDO
@@ -1562,6 +1449,7 @@ paths:
1562
1449
  enum:
1563
1450
  - ACCEPTED
1564
1451
  signedPayload:
1452
+ title: SignedPayloadFIDO
1565
1453
  type: object
1566
1454
  properties:
1567
1455
  signedPayloadType:
@@ -1574,9 +1462,14 @@ paths:
1574
1462
  title: FIDOPublicKeyCredentialAssertion
1575
1463
  type: object
1576
1464
  description: |
1577
- An object sent in a `PUT /thirdpartyRequests/authorization/{ID}` request.
1578
- based mostly on: https://webauthn.guide/#authentication
1579
- AuthenticatorAssertionResponse
1465
+ A data model representing a FIDO Assertion result.
1466
+ Derived from PublicKeyCredential Interface in WebAuthN.
1467
+
1468
+ The PublicKeyCredential interface represents the below fields with a Type of
1469
+ Javascript ArrayBuffer.
1470
+ For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
1471
+
1472
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
1580
1473
  properties:
1581
1474
  id:
1582
1475
  type: string
@@ -1641,6 +1534,8 @@ paths:
1641
1534
  - signedPayloadType
1642
1535
  - fidoSignedPayload
1643
1536
  additionalProperties: false
1537
+ extensionList:
1538
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
1644
1539
  required:
1645
1540
  - responseType
1646
1541
  - signedPayload
@@ -1650,8 +1545,9 @@ paths:
1650
1545
  description: 'The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.'
1651
1546
  properties:
1652
1547
  responseType:
1653
- $ref: '#/paths/~1thirdpartyRequests~1authorizations~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/1/responseType'
1548
+ $ref: '#/paths/~1thirdpartyRequests~1authorizations~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/1/properties/responseType'
1654
1549
  signedPayload:
1550
+ title: SignedPayloadGeneric
1655
1551
  type: object
1656
1552
  properties:
1657
1553
  signedPayloadType:
@@ -1661,11 +1557,13 @@ paths:
1661
1557
  - GENERIC
1662
1558
  description: Describes a challenge that has been signed with a private key
1663
1559
  genericSignedPayload:
1664
- $ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/authToken'
1560
+ $ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/authToken'
1665
1561
  required:
1666
1562
  - signedPayloadType
1667
1563
  - genericSignedPayload
1668
1564
  additionalProperties: false
1565
+ extensionList:
1566
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
1669
1567
  required:
1670
1568
  - responseType
1671
1569
  - signedPayload
@@ -1772,13 +1670,18 @@ paths:
1772
1670
  schema:
1773
1671
  title: ThirdpartyRequestsTransactionsPostRequest
1774
1672
  type: object
1775
- description: The object sent in the POST /thirdpartyRequests/transactions request.
1673
+ description: |-
1674
+ Used by: PISP
1675
+ The HTTP request POST /thirdpartyRequests/transactions is used to request the creation of a transaction request on the server for the transfer described in the request.
1676
+ Callback and data model information for POST /thirdpartyRequests/transactions:
1677
+ Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below
1678
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
1776
1679
  properties:
1777
1680
  transactionRequestId:
1778
1681
  allOf:
1779
- - $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
1682
+ - $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
1780
1683
  description: |
1781
- Common ID between the PISP and the Payer DFSP for the transaction request object. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request.
1684
+ Common ID between the PISP and the Payer DFSP for the transaction request object. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request.
1782
1685
  payee:
1783
1686
  allOf:
1784
1687
  - title: Party
@@ -1786,13 +1689,13 @@ paths:
1786
1689
  description: Data model for the complex type Party.
1787
1690
  properties:
1788
1691
  partyIdInfo:
1789
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/payer/allOf/0'
1692
+ $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payer/allOf/0'
1790
1693
  merchantClassificationCode:
1791
- $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/put/requestBody/content/application~1json/schema/party/merchantClassificationCode'
1694
+ $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/put/requestBody/content/application~1json/schema/properties/party/properties/merchantClassificationCode'
1792
1695
  name:
1793
- $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/put/requestBody/content/application~1json/schema/party/name'
1696
+ $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/put/requestBody/content/application~1json/schema/properties/party/properties/name'
1794
1697
  personalInfo:
1795
- $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/put/requestBody/content/application~1json/schema/party/personalInfo'
1698
+ $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/put/requestBody/content/application~1json/schema/properties/party/properties/personalInfo'
1796
1699
  required:
1797
1700
  - partyIdInfo
1798
1701
  description: Information about the Payee in the proposed financial transaction.
@@ -1829,7 +1732,7 @@ paths:
1829
1732
  [RFC 3696](https://tools.ietf.org/html/rfc3696).
1830
1733
  - PERSONAL_ID - A personal identifier is used as reference to a participant.
1831
1734
  Examples of personal identification are passport number, birth certificate
1832
- number, and national registration number. The identifier number is added in
1735
+ number, and national registration number. The identifier number is added in
1833
1736
  the PartyIdentifier element. The personal identifier type is added in the
1834
1737
  PartySubIdOrType element.
1835
1738
  - BUSINESS - A specific Business (for example, an organization or a company)
@@ -1853,12 +1756,12 @@ paths:
1853
1756
  PartySubIdOrType element for identifying an account under an Alias defined
1854
1757
  by the PartyIdentifier.
1855
1758
  - CONSENT - A Consent represents an agreement between a PISP, a Customer and
1856
- a DFSP which allows the PISP permission to perform actions on behalf of the
1857
- customer. A Consent has an authoritative source: either the DFSP who issued
1759
+ a DFSP which allows the PISP permission to perform actions on behalf of the
1760
+ customer. A Consent has an authoritative source: either the DFSP who issued
1858
1761
  the Consent, or an Auth Service which administers the Consent.
1859
1762
  - THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP,
1860
- a DFSP, and a specific Customer's account at the DFSP. The content of the link
1861
- is created by the DFSP at the time when it gives permission to the PISP for
1763
+ a DFSP, and a specific Customer's account at the DFSP. The content of the link
1764
+ is created by the DFSP at the time when it gives permission to the PISP for
1862
1765
  specific access to a given account.
1863
1766
  example: PERSONAL_ID
1864
1767
  partyIdentifier:
@@ -1875,9 +1778,9 @@ paths:
1875
1778
  maxLength: 128
1876
1779
  description: 'Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.'
1877
1780
  fspId:
1878
- $ref: '#/paths/~1services~1%7BServiceType%7D/put/requestBody/content/application~1json/schema/providers/items'
1781
+ $ref: '#/paths/~1services~1%7BServiceType%7D/put/requestBody/content/application~1json/schema/properties/providers/items'
1879
1782
  extensionList:
1880
- $ref: '#/paths/~1thirdpartyRequests~1authorizations/post/requestBody/content/application~1json/schema/extensionList'
1783
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
1881
1784
  required:
1882
1785
  - partyIdType
1883
1786
  - partyIdentifier
@@ -1902,7 +1805,176 @@ paths:
1902
1805
  description: Data model for the complex type Money.
1903
1806
  properties:
1904
1807
  currency:
1905
- $ref: '#/paths/~1accounts~1%7BID%7D/put/requestBody/content/application~1json/schema/accountList/items/currency'
1808
+ title: Currency
1809
+ 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.'
1810
+ type: string
1811
+ minLength: 3
1812
+ maxLength: 3
1813
+ enum:
1814
+ - AED
1815
+ - AFN
1816
+ - ALL
1817
+ - AMD
1818
+ - ANG
1819
+ - AOA
1820
+ - ARS
1821
+ - AUD
1822
+ - AWG
1823
+ - AZN
1824
+ - BAM
1825
+ - BBD
1826
+ - BDT
1827
+ - BGN
1828
+ - BHD
1829
+ - BIF
1830
+ - BMD
1831
+ - BND
1832
+ - BOB
1833
+ - BRL
1834
+ - BSD
1835
+ - BTN
1836
+ - BWP
1837
+ - BYN
1838
+ - BZD
1839
+ - CAD
1840
+ - CDF
1841
+ - CHF
1842
+ - CLP
1843
+ - CNY
1844
+ - COP
1845
+ - CRC
1846
+ - CUC
1847
+ - CUP
1848
+ - CVE
1849
+ - CZK
1850
+ - DJF
1851
+ - DKK
1852
+ - DOP
1853
+ - DZD
1854
+ - EGP
1855
+ - ERN
1856
+ - ETB
1857
+ - EUR
1858
+ - FJD
1859
+ - FKP
1860
+ - GBP
1861
+ - GEL
1862
+ - GGP
1863
+ - GHS
1864
+ - GIP
1865
+ - GMD
1866
+ - GNF
1867
+ - GTQ
1868
+ - GYD
1869
+ - HKD
1870
+ - HNL
1871
+ - HRK
1872
+ - HTG
1873
+ - HUF
1874
+ - IDR
1875
+ - ILS
1876
+ - IMP
1877
+ - INR
1878
+ - IQD
1879
+ - IRR
1880
+ - ISK
1881
+ - JEP
1882
+ - JMD
1883
+ - JOD
1884
+ - JPY
1885
+ - KES
1886
+ - KGS
1887
+ - KHR
1888
+ - KMF
1889
+ - KPW
1890
+ - KRW
1891
+ - KWD
1892
+ - KYD
1893
+ - KZT
1894
+ - LAK
1895
+ - LBP
1896
+ - LKR
1897
+ - LRD
1898
+ - LSL
1899
+ - LYD
1900
+ - MAD
1901
+ - MDL
1902
+ - MGA
1903
+ - MKD
1904
+ - MMK
1905
+ - MNT
1906
+ - MOP
1907
+ - MRO
1908
+ - MUR
1909
+ - MVR
1910
+ - MWK
1911
+ - MXN
1912
+ - MYR
1913
+ - MZN
1914
+ - NAD
1915
+ - NGN
1916
+ - NIO
1917
+ - NOK
1918
+ - NPR
1919
+ - NZD
1920
+ - OMR
1921
+ - PAB
1922
+ - PEN
1923
+ - PGK
1924
+ - PHP
1925
+ - PKR
1926
+ - PLN
1927
+ - PYG
1928
+ - QAR
1929
+ - RON
1930
+ - RSD
1931
+ - RUB
1932
+ - RWF
1933
+ - SAR
1934
+ - SBD
1935
+ - SCR
1936
+ - SDG
1937
+ - SEK
1938
+ - SGD
1939
+ - SHP
1940
+ - SLL
1941
+ - SOS
1942
+ - SPL
1943
+ - SRD
1944
+ - STD
1945
+ - SVC
1946
+ - SYP
1947
+ - SZL
1948
+ - THB
1949
+ - TJS
1950
+ - TMT
1951
+ - TND
1952
+ - TOP
1953
+ - TRY
1954
+ - TTD
1955
+ - TVD
1956
+ - TWD
1957
+ - TZS
1958
+ - UAH
1959
+ - UGX
1960
+ - USD
1961
+ - UYU
1962
+ - UZS
1963
+ - VEF
1964
+ - VND
1965
+ - VUV
1966
+ - WST
1967
+ - XAF
1968
+ - XCD
1969
+ - XDR
1970
+ - XOF
1971
+ - XPF
1972
+ - XTS
1973
+ - XXX
1974
+ - YER
1975
+ - ZAR
1976
+ - ZMW
1977
+ - ZWD
1906
1978
  amount:
1907
1979
  title: Amount
1908
1980
  type: string
@@ -1915,7 +1987,7 @@ paths:
1915
1987
  description: Requested amount to be transferred from the Payer to Payee.
1916
1988
  transactionType:
1917
1989
  allOf:
1918
- - $ref: '#/paths/~1thirdpartyRequests~1authorizations/post/requestBody/content/application~1json/schema/transactionType'
1990
+ - $ref: '#/paths/~1thirdpartyRequests~1authorizations/post/requestBody/content/application~1json/schema/properties/transactionType'
1919
1991
  description: Type of transaction.
1920
1992
  note:
1921
1993
  type: string
@@ -1927,6 +1999,8 @@ paths:
1927
1999
  description: |
1928
2000
  Date and time until when the transaction request is valid. It can be set to get a quick failure in case the peer FSP takes too long to respond.
1929
2001
  example: '2016-05-24T08:38:08.699-04:00'
2002
+ extensionList:
2003
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
1930
2004
  required:
1931
2005
  - transactionRequestId
1932
2006
  - payee
@@ -2016,7 +2090,10 @@ paths:
2016
2090
  schema:
2017
2091
  title: ThirdpartyRequestsTransactionsIDPutResponse
2018
2092
  type: object
2019
- description: 'The object sent in the PUT /thirdPartyRequests/transactions/{ID} request.'
2093
+ description: |-
2094
+ Used by: DFSP
2095
+ After a PISP requests the creation of a Third Party Transaction request (POST /thirdpartyRequests/transactions) or the status of a previously created Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}), the DFSP will send this callback.
2096
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
2020
2097
  properties:
2021
2098
  transactionRequestState:
2022
2099
  title: TransactionRequestState
@@ -2033,6 +2110,8 @@ paths:
2033
2110
  - ACCEPTED - Payer has approved the transaction.
2034
2111
  - REJECTED - Payer has rejected the transaction.
2035
2112
  example: RECEIVED
2113
+ extensionList:
2114
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
2036
2115
  required:
2037
2116
  - transactionRequestState
2038
2117
  example:
@@ -2076,7 +2155,12 @@ paths:
2076
2155
  schema:
2077
2156
  title: ThirdpartyRequestsTransactionsIDPatchResponse
2078
2157
  type: object
2079
- description: 'The object sent in the PATCH /thirdpartyRequests/transactions/{ID} callback.'
2158
+ description: |-
2159
+ Used by: DFSP
2160
+ The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer.
2161
+ This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource.
2162
+ The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request.
2163
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
2080
2164
  properties:
2081
2165
  completedTimestamp:
2082
2166
  title: DateTime
@@ -2085,7 +2169,7 @@ paths:
2085
2169
  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).'
2086
2170
  example: '2016-05-24T08:38:08.699-04:00'
2087
2171
  transactionRequestState:
2088
- $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/put/requestBody/content/application~1json/schema/transactionRequestState'
2172
+ $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/put/requestBody/content/application~1json/schema/properties/transactionRequestState'
2089
2173
  transactionState:
2090
2174
  title: TransactionState
2091
2175
  type: string
@@ -2101,6 +2185,8 @@ paths:
2101
2185
  - COMPLETED - Payee FSP has successfully performed the transaction.
2102
2186
  - REJECTED - Payee FSP has failed to perform the transaction.
2103
2187
  example: RECEIVED
2188
+ extensionList:
2189
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
2104
2190
  required:
2105
2191
  - transactionRequestState
2106
2192
  - transactionState
@@ -2274,7 +2360,7 @@ paths:
2274
2360
  description: Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
2275
2361
  properties:
2276
2362
  errorInformation:
2277
- $ref: '#/paths/~1accounts~1%7BID%7D~1error/put/requestBody/content/application~1json/schema/errorInformation'
2363
+ $ref: '#/paths/~1accounts~1%7BID%7D~1error/put/requestBody/content/application~1json/schema/properties/errorInformation'
2278
2364
  headers:
2279
2365
  Content-Length:
2280
2366
  required: false
@@ -2425,13 +2511,13 @@ paths:
2425
2511
  - 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.
2426
2512
  - 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.
2427
2513
  partyIdentifier:
2428
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/payer/allOf/0/partyIdentifier'
2514
+ $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payer/allOf/0/properties/partyIdentifier'
2429
2515
  partySubIdOrType:
2430
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/payer/allOf/0/partySubIdOrType'
2516
+ $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payer/allOf/0/properties/partySubIdOrType'
2431
2517
  fspId:
2432
- $ref: '#/paths/~1services~1%7BServiceType%7D/put/requestBody/content/application~1json/schema/providers/items'
2518
+ $ref: '#/paths/~1services~1%7BServiceType%7D/put/requestBody/content/application~1json/schema/properties/providers/items'
2433
2519
  extensionList:
2434
- $ref: '#/paths/~1thirdpartyRequests~1authorizations/post/requestBody/content/application~1json/schema/extensionList'
2520
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
2435
2521
  required:
2436
2522
  - partyIdType
2437
2523
  - partyIdentifier
@@ -2747,7 +2833,12 @@ paths:
2747
2833
  schema:
2748
2834
  title: ServicesServiceTypePutResponse
2749
2835
  type: object
2750
- description: 'The object sent in a `PUT /services/{ServiceType}` request.'
2836
+ description: |-
2837
+ Used by: Switch
2838
+ The callback PUT /services/{ServiceType} is used to inform the client of a successful result of the service information lookup.
2839
+ Callback and data model information for GET /services/{ServiceType}:
2840
+ Callback - PUT /services/{ServiceType} Error Callback - PUT /services/{ServiceType}/error Data Model - Empty body
2841
+ https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
2751
2842
  properties:
2752
2843
  providers:
2753
2844
  type: array
@@ -2759,6 +2850,8 @@ paths:
2759
2850
  minLength: 1
2760
2851
  maxLength: 32
2761
2852
  description: FSP identifier.
2853
+ extensionList:
2854
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
2762
2855
  required:
2763
2856
  - providers
2764
2857
  responses: