@mojaloop/api-snippets 18.3.2 → 18.4.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 (213) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/audit-ci.jsonc +5 -1
  3. package/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +0 -2
  4. package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +1 -1
  5. package/docs/thirdparty-admin-v2.0-openapi3-snippets.yaml +3705 -0
  6. package/docs/thirdparty-v1.0-openapi3-snippets.yaml +3802 -0
  7. package/docs/thirdparty-v2.0-openapi3-snippets.yaml +1825 -0
  8. package/eslint.config.mjs +70 -0
  9. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +0 -1
  10. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +0 -1
  11. package/lib/fspiop/v2_0/index.js +0 -1
  12. package/lib/fspiop/v2_0/index.js.map +1 -1
  13. package/lib/fspiop/v2_0_ISO20022/index.js +0 -1
  14. package/lib/fspiop/v2_0_ISO20022/index.js.map +1 -1
  15. package/lib/fspiop/v2_0_ISO20022/json-schemas.json +0 -71
  16. package/lib/fspiop/v2_0_ISO20022/schemas.d.ts +0 -140
  17. package/lib/index.js +0 -1
  18. package/lib/index.js.map +1 -1
  19. package/lib/sdk-scheme-adapter/v2_0_0/backend/index.js +0 -1
  20. package/lib/sdk-scheme-adapter/v2_0_0/backend/index.js.map +1 -1
  21. package/lib/sdk-scheme-adapter/v2_0_0/outbound/index.js +0 -1
  22. package/lib/sdk-scheme-adapter/v2_0_0/outbound/index.js.map +1 -1
  23. package/lib/sdk-scheme-adapter/v2_1_0/backend/index.js +0 -1
  24. package/lib/sdk-scheme-adapter/v2_1_0/backend/index.js.map +1 -1
  25. package/lib/sdk-scheme-adapter/v2_1_0/outbound/index.js +0 -1
  26. package/lib/sdk-scheme-adapter/v2_1_0/outbound/index.js.map +1 -1
  27. package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +1 -1
  28. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +1 -1
  29. package/lib/thirdparty/v2_0/openapi.d.ts +1726 -0
  30. package/lib/thirdparty/v2_0/openapi.js +7 -0
  31. package/lib/thirdparty/v2_0/openapi.js.map +1 -0
  32. package/package.json +48 -45
  33. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferRequest.yaml +1 -1
  34. package/test/dto/{thirdparty.test.ts → thirdparty_v1_0.test.ts} +1 -1
  35. package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml +68 -61
  36. package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml +82 -75
  37. package/thirdparty/v2_0/openapi3/components/headers/Content-Length.yaml +1 -0
  38. package/thirdparty/v2_0/openapi3/components/headers/Content-Type.yaml +1 -0
  39. package/thirdparty/v2_0/openapi3/components/parameters/Accept.yaml +1 -0
  40. package/thirdparty/v2_0/openapi3/components/parameters/Content-Length.yaml +1 -0
  41. package/thirdparty/v2_0/openapi3/components/parameters/Content-Type.yaml +1 -0
  42. package/thirdparty/v2_0/openapi3/components/parameters/Date.yaml +1 -0
  43. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Destination.yaml +1 -0
  44. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Encryption.yaml +1 -0
  45. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -0
  46. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Signature.yaml +1 -0
  47. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Source.yaml +1 -0
  48. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-URI.yaml +1 -0
  49. package/thirdparty/v2_0/openapi3/components/parameters/ID.yaml +1 -0
  50. package/thirdparty/v2_0/openapi3/components/parameters/ServiceType.yaml +6 -0
  51. package/thirdparty/v2_0/openapi3/components/parameters/SubId.yaml +1 -0
  52. package/thirdparty/v2_0/openapi3/components/parameters/Type.yaml +1 -0
  53. package/thirdparty/v2_0/openapi3/components/parameters/X-Forwarded-For.yaml +1 -0
  54. package/thirdparty/v2_0/openapi3/components/responses/200.yaml +1 -0
  55. package/thirdparty/v2_0/openapi3/components/responses/202.yaml +1 -0
  56. package/thirdparty/v2_0/openapi3/components/responses/400.yaml +1 -0
  57. package/thirdparty/v2_0/openapi3/components/responses/401.yaml +1 -0
  58. package/thirdparty/v2_0/openapi3/components/responses/403.yaml +1 -0
  59. package/thirdparty/v2_0/openapi3/components/responses/404.yaml +1 -0
  60. package/thirdparty/v2_0/openapi3/components/responses/405.yaml +1 -0
  61. package/thirdparty/v2_0/openapi3/components/responses/406.yaml +1 -0
  62. package/thirdparty/v2_0/openapi3/components/responses/501.yaml +1 -0
  63. package/thirdparty/v2_0/openapi3/components/responses/503.yaml +1 -0
  64. package/thirdparty/v2_0/openapi3/components/schemas/Account.yaml +17 -0
  65. package/thirdparty/v2_0/openapi3/components/schemas/AccountAddress.yaml +25 -0
  66. package/thirdparty/v2_0/openapi3/components/schemas/AccountList.yaml +11 -0
  67. package/thirdparty/v2_0/openapi3/components/schemas/Amount.yaml +1 -0
  68. package/thirdparty/v2_0/openapi3/components/schemas/AmountType.yaml +1 -0
  69. package/thirdparty/v2_0/openapi3/components/schemas/AuthenticationResponse.yaml +10 -0
  70. package/thirdparty/v2_0/openapi3/components/schemas/AuthenticatorAssertionResponse.yaml +32 -0
  71. package/thirdparty/v2_0/openapi3/components/schemas/AuthenticatorAttestationResponse.yaml +23 -0
  72. package/thirdparty/v2_0/openapi3/components/schemas/AuthorizationResponseType.yaml +8 -0
  73. package/thirdparty/v2_0/openapi3/components/schemas/AuthorizationResponseTypeAccepted.yaml +6 -0
  74. package/thirdparty/v2_0/openapi3/components/schemas/AuthorizationResponseTypeRejected.yaml +6 -0
  75. package/thirdparty/v2_0/openapi3/components/schemas/BinaryString.yaml +1 -0
  76. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestChannelType.yaml +9 -0
  77. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestChannelTypeOTP.yaml +6 -0
  78. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestChannelTypeWeb.yaml +6 -0
  79. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsIDPatchRequest.yaml +16 -0
  80. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsIDPutResponseOTP.yaml +30 -0
  81. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsIDPutResponseWeb.yaml +39 -0
  82. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsPostRequest.yaml +44 -0
  83. package/thirdparty/v2_0/openapi3/components/schemas/ConsentStatus.yaml +9 -0
  84. package/thirdparty/v2_0/openapi3/components/schemas/ConsentStatusIssued.yaml +7 -0
  85. package/thirdparty/v2_0/openapi3/components/schemas/ConsentStatusRevoked.yaml +7 -0
  86. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPatchResponseRevoked.yaml +17 -0
  87. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPatchResponseVerified.yaml +19 -0
  88. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPutResponseSigned.yaml +23 -0
  89. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPutResponseVerified.yaml +23 -0
  90. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsPostRequestAUTH.yaml +33 -0
  91. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsPostRequestPISP.yaml +32 -0
  92. package/thirdparty/v2_0/openapi3/components/schemas/CorrelationId.yaml +1 -0
  93. package/thirdparty/v2_0/openapi3/components/schemas/CredentialStatusPending.yaml +7 -0
  94. package/thirdparty/v2_0/openapi3/components/schemas/CredentialStatusVerified.yaml +7 -0
  95. package/thirdparty/v2_0/openapi3/components/schemas/CredentialType.yaml +11 -0
  96. package/thirdparty/v2_0/openapi3/components/schemas/Currency.yaml +1 -0
  97. package/thirdparty/v2_0/openapi3/components/schemas/DateOfBirth.yaml +1 -0
  98. package/thirdparty/v2_0/openapi3/components/schemas/DateTime.yaml +1 -0
  99. package/thirdparty/v2_0/openapi3/components/schemas/ErrorCode.yaml +1 -0
  100. package/thirdparty/v2_0/openapi3/components/schemas/ErrorDescription.yaml +1 -0
  101. package/thirdparty/v2_0/openapi3/components/schemas/ErrorInformation.yaml +1 -0
  102. package/thirdparty/v2_0/openapi3/components/schemas/Extension.yaml +1 -0
  103. package/thirdparty/v2_0/openapi3/components/schemas/ExtensionKey.yaml +1 -0
  104. package/thirdparty/v2_0/openapi3/components/schemas/ExtensionList.yaml +1 -0
  105. package/thirdparty/v2_0/openapi3/components/schemas/ExtensionValue.yaml +1 -0
  106. package/thirdparty/v2_0/openapi3/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +71 -0
  107. package/thirdparty/v2_0/openapi3/components/schemas/FIDOPublicKeyCredentialAttestation.yaml +54 -0
  108. package/thirdparty/v2_0/openapi3/components/schemas/FirstName.yaml +1 -0
  109. package/thirdparty/v2_0/openapi3/components/schemas/FspId.yaml +1 -0
  110. package/thirdparty/v2_0/openapi3/components/schemas/GenericCredential.yaml +13 -0
  111. package/thirdparty/v2_0/openapi3/components/schemas/GeoCode.yaml +1 -0
  112. package/thirdparty/v2_0/openapi3/components/schemas/IlpCondition.yaml +1 -0
  113. package/thirdparty/v2_0/openapi3/components/schemas/IlpFulfilment.yaml +1 -0
  114. package/thirdparty/v2_0/openapi3/components/schemas/IlpPacket.yaml +1 -0
  115. package/thirdparty/v2_0/openapi3/components/schemas/Integer.yaml +1 -0
  116. package/thirdparty/v2_0/openapi3/components/schemas/LastName.yaml +1 -0
  117. package/thirdparty/v2_0/openapi3/components/schemas/Latitude.yaml +1 -0
  118. package/thirdparty/v2_0/openapi3/components/schemas/Longitude.yaml +1 -0
  119. package/thirdparty/v2_0/openapi3/components/schemas/MerchantClassificationCode.yaml +1 -0
  120. package/thirdparty/v2_0/openapi3/components/schemas/MiddleName.yaml +1 -0
  121. package/thirdparty/v2_0/openapi3/components/schemas/Money.yaml +1 -0
  122. package/thirdparty/v2_0/openapi3/components/schemas/Name.yaml +2 -0
  123. package/thirdparty/v2_0/openapi3/components/schemas/Note.yaml +1 -0
  124. package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsIDPutResponse.yaml +17 -0
  125. package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsPostRequest.yaml +20 -0
  126. package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsTypeIDPutResponse.yaml +8 -0
  127. package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml +15 -0
  128. package/thirdparty/v2_0/openapi3/components/schemas/PartiesTypeIDPutResponse.yaml +13 -0
  129. package/thirdparty/v2_0/openapi3/components/schemas/Party.yaml +15 -0
  130. package/thirdparty/v2_0/openapi3/components/schemas/PartyComplexName.yaml +1 -0
  131. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdInfo.yaml +17 -0
  132. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdInfoTPLink.yaml +17 -0
  133. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdType.yaml +58 -0
  134. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdTypeTPLink.yaml +7 -0
  135. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdentifier.yaml +1 -0
  136. package/thirdparty/v2_0/openapi3/components/schemas/PartyName.yaml +1 -0
  137. package/thirdparty/v2_0/openapi3/components/schemas/PartyPersonalInfo.yaml +1 -0
  138. package/thirdparty/v2_0/openapi3/components/schemas/PartyResult.yaml +10 -0
  139. package/thirdparty/v2_0/openapi3/components/schemas/PartySubIdOrType.yaml +1 -0
  140. package/thirdparty/v2_0/openapi3/components/schemas/PartyTPLink.yaml +14 -0
  141. package/thirdparty/v2_0/openapi3/components/schemas/QuotesIDPutResponse.yaml +1 -0
  142. package/thirdparty/v2_0/openapi3/components/schemas/QuotesPostRequest.yaml +79 -0
  143. package/thirdparty/v2_0/openapi3/components/schemas/Scope.yaml +20 -0
  144. package/thirdparty/v2_0/openapi3/components/schemas/ScopeAction.yaml +14 -0
  145. package/thirdparty/v2_0/openapi3/components/schemas/ServiceType.yaml +15 -0
  146. package/thirdparty/v2_0/openapi3/components/schemas/ServicesServiceTypePutResponse.yaml +26 -0
  147. package/thirdparty/v2_0/openapi3/components/schemas/SignedCredential.yaml +23 -0
  148. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadFIDO.yaml +11 -0
  149. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadGeneric.yaml +11 -0
  150. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadType.yaml +9 -0
  151. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadTypeFIDO.yaml +5 -0
  152. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadTypeGeneric.yaml +5 -0
  153. package/thirdparty/v2_0/openapi3/components/schemas/Transaction.yaml +43 -0
  154. package/thirdparty/v2_0/openapi3/components/schemas/TransactionRequestState.yaml +1 -0
  155. package/thirdparty/v2_0/openapi3/components/schemas/TransactionState.yaml +1 -0
  156. package/thirdparty/v2_0/openapi3/components/schemas/TransactionType.yaml +1 -0
  157. package/thirdparty/v2_0/openapi3/components/schemas/TransfersPostRequestFIDO.yaml +15 -0
  158. package/thirdparty/v2_0/openapi3/components/schemas/TransfersPostRequestGeneric.yaml +15 -0
  159. package/thirdparty/v2_0/openapi3/components/schemas/Uri.yaml +8 -0
  160. package/thirdparty/v2_0/openapi3/components/schemas/VerifiedCredential.yaml +23 -0
  161. package/thirdparty/v2_0/openapi3/components/schemas/tppAccountRequestPostRequest.yaml +35 -0
  162. package/thirdparty/v2_0/openapi3/components/schemas/tppAccountRequestPutResponse.yaml +30 -0
  163. package/thirdparty/v2_0/openapi3/components/schemas/tppAccountsIDPutResponse.yaml +21 -0
  164. package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseFIDO.yaml +15 -0
  165. package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseGeneric.yaml +15 -0
  166. package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseRejected.yaml +10 -0
  167. package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsPostRequest.yaml +67 -0
  168. package/thirdparty/v2_0/openapi3/components/schemas/tppTransactionRequestPostRequest.yaml +60 -0
  169. package/thirdparty/v2_0/openapi3/components/schemas/tppTransactionRequestPutResponse.yaml +67 -0
  170. package/thirdparty/v2_0/openapi3/components/schemas/tppTransfersPostRequest.yaml +19 -0
  171. package/thirdparty/v2_0/openapi3/components/schemas/tppTransfersPutResponse.yaml +25 -0
  172. package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsIDPutResponse.yaml +19 -0
  173. package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsPostRequestFIDO.yaml +28 -0
  174. package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsPostRequestGeneric.yaml +28 -0
  175. package/thirdparty/v2_0/openapi3/openapi-admin.yaml +99 -0
  176. package/thirdparty/v2_0/openapi3/openapi.yaml +64 -0
  177. package/thirdparty/v2_0/openapi3/paths/health.yaml +25 -0
  178. package/thirdparty/v2_0/openapi3/paths/metrics.yaml +25 -0
  179. package/thirdparty/v2_0/openapi3/paths/participants.yaml +50 -0
  180. package/thirdparty/v2_0/openapi3/paths/participants_ID.yaml +49 -0
  181. package/thirdparty/v2_0/openapi3/paths/participants_ID_error.yaml +51 -0
  182. package/thirdparty/v2_0/openapi3/paths/participants_Type_ID.yaml +169 -0
  183. package/thirdparty/v2_0/openapi3/paths/participants_Type_ID_error.yaml +52 -0
  184. package/thirdparty/v2_0/openapi3/paths/services_ServiceType.yaml +77 -0
  185. package/thirdparty/v2_0/openapi3/paths/services_ServiceType_error.yaml +49 -0
  186. package/thirdparty/v2_0/openapi3/paths/tppAccountRequest.yaml +49 -0
  187. package/thirdparty/v2_0/openapi3/paths/tppAccountRequest_ID.yaml +86 -0
  188. package/thirdparty/v2_0/openapi3/paths/tppAccountRequest_ID_error.yaml +48 -0
  189. package/thirdparty/v2_0/openapi3/paths/tppAccounts_ID.yaml +88 -0
  190. package/thirdparty/v2_0/openapi3/paths/tppAccounts_ID_error.yaml +48 -0
  191. package/thirdparty/v2_0/openapi3/paths/tppAuthorizations.yaml +51 -0
  192. package/thirdparty/v2_0/openapi3/paths/tppAuthorizations_ID.yaml +86 -0
  193. package/thirdparty/v2_0/openapi3/paths/tppAuthorizations_ID_error.yaml +55 -0
  194. package/thirdparty/v2_0/openapi3/paths/tppConsentRequests.yaml +48 -0
  195. package/thirdparty/v2_0/openapi3/paths/tppConsentRequests_ID.yaml +123 -0
  196. package/thirdparty/v2_0/openapi3/paths/tppConsentRequests_ID_error.yaml +48 -0
  197. package/thirdparty/v2_0/openapi3/paths/tppConsents.yaml +49 -0
  198. package/thirdparty/v2_0/openapi3/paths/tppConsents_ID.yaml +165 -0
  199. package/thirdparty/v2_0/openapi3/paths/tppConsents_ID_error.yaml +48 -0
  200. package/thirdparty/v2_0/openapi3/paths/tppTransactionRequests.yaml +48 -0
  201. package/thirdparty/v2_0/openapi3/paths/tppTransactionRequests_ID.yaml +83 -0
  202. package/thirdparty/v2_0/openapi3/paths/tppTransactionRequests_ID_error.yaml +52 -0
  203. package/thirdparty/v2_0/openapi3/paths/tppTransfers.yaml +47 -0
  204. package/thirdparty/v2_0/openapi3/paths/tppTransfers_ID.yaml +86 -0
  205. package/thirdparty/v2_0/openapi3/paths/tppTransfers_ID_error.yaml +52 -0
  206. package/thirdparty/v2_0/openapi3/paths/tppVerifications.yaml +49 -0
  207. package/thirdparty/v2_0/openapi3/paths/tppVerifications_ID.yaml +87 -0
  208. package/thirdparty/v2_0/openapi3/paths/tppVerifications_ID_error.yaml +49 -0
  209. package/thirdparty/v2_0/openapi3/thirdparty-dfsp-admin-api.template.yaml +53 -0
  210. package/thirdparty/v2_0/openapi3/thirdparty-dfsp-admin-api.yaml +2633 -0
  211. package/thirdparty/v2_0/openapi3/thirdparty-pisp-admin-api.template.yaml +57 -0
  212. package/thirdparty/v2_0/openapi3/thirdparty-pisp-admin-api.yaml +3103 -0
  213. package/tsconfig.build.json +4 -3
@@ -0,0 +1,71 @@
1
+ title: FIDOPublicKeyCredentialAssertion
2
+ type: object
3
+ description: |
4
+ A data model representing a FIDO Assertion result.
5
+ Derived from PublicKeyCredential Interface in WebAuthN.
6
+
7
+ The PublicKeyCredential interface represents the below fields with a Type of
8
+ Javascript ArrayBuffer.
9
+ For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
10
+
11
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
12
+ properties:
13
+ id:
14
+ type: string
15
+ description: |
16
+ credential id: identifier of pair of keys, base64 encoded
17
+ https://w3c.github.io/webauthn/#ref-for-dom-credential-id
18
+ minLength: 20
19
+ maxLength: 118
20
+ rawId:
21
+ type: string
22
+ description: |
23
+ raw credential id: identifier of pair of keys, base64 encoded.
24
+ minLength: 20
25
+ maxLength: 118
26
+ response:
27
+ type: object
28
+ description: |
29
+ AuthenticatorAssertionResponse
30
+ properties:
31
+ authenticatorData:
32
+ type: string
33
+ description: |
34
+ Authenticator data object.
35
+ minLength: 49
36
+ maxLength: 256
37
+ clientDataJSON:
38
+ type: string
39
+ description: |
40
+ JSON string with client data.
41
+ minLength: 121
42
+ maxLength: 512
43
+ signature:
44
+ type: string
45
+ description: |
46
+ The signature generated by the private key associated with this credential.
47
+ minLength: 59
48
+ maxLength: 256
49
+ userHandle:
50
+ type: string
51
+ description: |
52
+ This field is optionally provided by the authenticator, and
53
+ represents the user.id that was supplied during registration.
54
+ minLength: 1
55
+ maxLength: 88
56
+ required:
57
+ - authenticatorData
58
+ - clientDataJSON
59
+ - signature
60
+ additionalProperties: false
61
+ type:
62
+ type: string
63
+ description: response type, we need only the type of public-key
64
+ enum:
65
+ - 'public-key'
66
+ required:
67
+ - id
68
+ - rawId
69
+ - response
70
+ - type
71
+ additionalProperties: false
@@ -0,0 +1,54 @@
1
+ title: FIDOPublicKeyCredentialAttestation
2
+ type: object
3
+ description: |
4
+ A data model representing a FIDO Attestation result. Derived from
5
+ [`PublicKeyCredential` Interface](https://w3c.github.io/webauthn/#iface-pkcredential).
6
+
7
+ The `PublicKeyCredential` interface represents the below fields with
8
+ a Type of Javascript [ArrayBuffer](https://heycam.github.io/webidl/#idl-ArrayBuffer).
9
+ For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
10
+ properties:
11
+ id:
12
+ type: string
13
+ description: |
14
+ credential id: identifier of pair of keys, base64 encoded
15
+ https://w3c.github.io/webauthn/#ref-for-dom-credential-id
16
+ minLength: 20
17
+ maxLength: 118
18
+ rawId:
19
+ type: string
20
+ description: |
21
+ raw credential id: identifier of pair of keys, base64 encoded
22
+ minLength: 20
23
+ maxLength: 118
24
+ response:
25
+ type: object
26
+ description: |
27
+ AuthenticatorAttestationResponse
28
+ properties:
29
+ clientDataJSON:
30
+ type: string
31
+ description: |
32
+ JSON string with client data
33
+ minLength: 121
34
+ maxLength: 512
35
+ attestationObject:
36
+ type: string
37
+ description: |
38
+ CBOR.encoded attestation object
39
+ minLength: 306
40
+ maxLength: 2048
41
+ required:
42
+ - clientDataJSON
43
+ - attestationObject
44
+ additionalProperties: false
45
+ type:
46
+ type: string
47
+ description: response type, we need only the type of public-key
48
+ enum:
49
+ - 'public-key'
50
+ required:
51
+ - id
52
+ - response
53
+ - type
54
+ additionalProperties: false
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/FirstName.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/FspId.yaml'
@@ -0,0 +1,13 @@
1
+ title: GenericCredential
2
+ type: object
3
+ description: |
4
+ A publicKey + signature of a challenge for a generic public/private keypair.
5
+ properties:
6
+ publicKey:
7
+ $ref: ./BinaryString.yaml
8
+ signature:
9
+ $ref: ./BinaryString.yaml
10
+ required:
11
+ - publicKey
12
+ - signature
13
+ additionalProperties: false
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/GeoCode.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/IlpCondition.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/IlpFulfilment.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/IlpPacket.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/Integer.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/LastName.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/Latitude.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/Longitude.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/MerchantClassificationCode.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/MiddleName.yaml'
@@ -0,0 +1 @@
1
+ $ref: ../../../../../fspiop/v2_0/openapi3/components/schemas/Money.yaml
@@ -0,0 +1,2 @@
1
+ $ref: ../../../../../fspiop/v2_0/openapi3/components/schemas/Name.yaml
2
+
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/Note.yaml'
@@ -0,0 +1,17 @@
1
+ title: ParticipantsIDPutResponse
2
+ type: object
3
+ description: 'The object sent in the PUT /participants/{ID} callback.'
4
+ properties:
5
+ partyList:
6
+ type: array
7
+ items:
8
+ $ref: ./PartyResult.yaml
9
+ minItems: 1
10
+ maxItems: 10000
11
+ description: >-
12
+ List of PartyResult elements that were either created or failed to be
13
+ created.
14
+ currency:
15
+ $ref: ./Currency.yaml
16
+ required:
17
+ - partyList
@@ -0,0 +1,20 @@
1
+ title: ParticipantsPostRequest
2
+ type: object
3
+ description: The object sent in the POST /participants request.
4
+ properties:
5
+ requestId:
6
+ $ref: ./CorrelationId.yaml
7
+ partyList:
8
+ type: array
9
+ items:
10
+ $ref: ./PartyIdInfo.yaml
11
+ minItems: 1
12
+ maxItems: 10000
13
+ description: |
14
+ List of PartyIdInfo elements that the client would like to update
15
+ or create FSP information about.
16
+ currency:
17
+ $ref: ./Currency.yaml
18
+ required:
19
+ - requestId
20
+ - partyList
@@ -0,0 +1,8 @@
1
+ title: ParticipantsTypeIDPutResponse
2
+ type: object
3
+ description: >-
4
+ The object sent in the PUT /participants/{Type}/{ID}/{SubId} and
5
+ /participants/{Type}/{ID} callbacks.
6
+ properties:
7
+ fspId:
8
+ $ref: ./FspId.yaml
@@ -0,0 +1,15 @@
1
+ title: ParticipantsTypeIDSubIDPostRequest
2
+ type: object
3
+ description: >-
4
+ The object sent in the POST /participants/{Type}/{ID}/{SubId} and
5
+ /participants/{Type}/{ID} requests. An additional optional ExtensionList
6
+ element has been added as part of v1.1 changes.
7
+ properties:
8
+ fspId:
9
+ $ref: ./FspId.yaml
10
+ currency:
11
+ $ref: ./Currency.yaml
12
+ extensionList:
13
+ $ref: ./ExtensionList.yaml
14
+ required:
15
+ - fspId
@@ -0,0 +1,13 @@
1
+ title: PartiesTypeIDPutResponse
2
+ type: object
3
+ description: |
4
+ The object sent in the PUT /parties/{Type}/{ID} callback.
5
+
6
+ This is a variant based on FSPIOP `PartiesTypeIDPutResponse` specification.
7
+ Main difference being that it returns a `Party` with the newly added
8
+ `accounts` property.
9
+ properties:
10
+ party:
11
+ $ref: ./Party.yaml
12
+ required:
13
+ - party
@@ -0,0 +1,15 @@
1
+ title: Party
2
+ type: object
3
+ description: Data model for the complex type Party.
4
+ properties:
5
+ partyIdInfo:
6
+ $ref: ./PartyIdInfo.yaml
7
+ merchantClassificationCode:
8
+ $ref: ./MerchantClassificationCode.yaml
9
+ name:
10
+ $ref: ./PartyName.yaml
11
+ personalInfo:
12
+ $ref: ./PartyPersonalInfo.yaml
13
+ required:
14
+ - partyIdInfo
15
+
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v1_1/openapi3/components/schemas/PartyComplexName.yaml'
@@ -0,0 +1,17 @@
1
+ title: PartyIdInfo
2
+ type: object
3
+ description: Data model for the complex type PartyIdInfo.
4
+ properties:
5
+ partyIdType:
6
+ $ref: ./PartyIdType.yaml
7
+ partyIdentifier:
8
+ $ref: ./PartyIdentifier.yaml
9
+ partySubIdOrType:
10
+ $ref: ./PartySubIdOrType.yaml
11
+ fspId:
12
+ $ref: ./FspId.yaml
13
+ extensionList:
14
+ $ref: ./ExtensionList.yaml
15
+ required:
16
+ - partyIdType
17
+ - partyIdentifier
@@ -0,0 +1,17 @@
1
+ title: PartyIdInfo
2
+ type: object
3
+ description: Data model for the complex type PartyIdInfo.
4
+ properties:
5
+ partyIdType:
6
+ $ref: ./PartyIdTypeTPLink.yaml
7
+ partyIdentifier:
8
+ $ref: ./PartyIdentifier.yaml
9
+ partySubIdOrType:
10
+ $ref: ./PartySubIdOrType.yaml
11
+ fspId:
12
+ $ref: ./FspId.yaml
13
+ extensionList:
14
+ $ref: ./ExtensionList.yaml
15
+ required:
16
+ - partyIdType
17
+ - partyIdentifier
@@ -0,0 +1,58 @@
1
+ title: PartyIdType
2
+ type: string
3
+ enum:
4
+ - MSISDN
5
+ - EMAIL
6
+ - PERSONAL_ID
7
+ - BUSINESS
8
+ - DEVICE
9
+ - ACCOUNT_ID
10
+ - IBAN
11
+ - ALIAS
12
+ - CONSENT
13
+ - THIRD_PARTY_LINK
14
+ description: |
15
+ Below are the allowed values for the enumeration.
16
+ - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
17
+ Number, that is, the phone number) is used as reference to a participant.
18
+ The MSISDN identifier should be in international format according to the
19
+ [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
20
+ Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
21
+ international prefix.
22
+ - EMAIL - An email is used as reference to a
23
+ participant. The format of the email should be according to the informational
24
+ [RFC 3696](https://tools.ietf.org/html/rfc3696).
25
+ - PERSONAL_ID - A personal identifier is used as reference to a participant.
26
+ Examples of personal identification are passport number, birth certificate
27
+ number, and national registration number. The identifier number is added in
28
+ the PartyIdentifier element. The personal identifier type is added in the
29
+ PartySubIdOrType element.
30
+ - BUSINESS - A specific Business (for example, an organization or a company)
31
+ is used as reference to a participant. The BUSINESS identifier can be in any
32
+ format. To make a transaction connected to a specific username or bill number
33
+ in a Business, the PartySubIdOrType element should be used.
34
+ - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
35
+ specific business or organization is used as reference to a Party.
36
+ For referencing a specific device under a specific business or organization,
37
+ use the PartySubIdOrType element.
38
+ - ACCOUNT_ID - A bank account number or FSP account ID should be used as
39
+ reference to a participant. The ACCOUNT_ID identifier can be in any format,
40
+ as formats can greatly differ depending on country and FSP.
41
+ - IBAN - A bank account number or FSP account ID is used as reference to a
42
+ participant. The IBAN identifier can consist of up to 34 alphanumeric
43
+ characters and should be entered without whitespace.
44
+ - ALIAS An alias is used as reference to a participant. The alias should be
45
+ created in the FSP as an alternative reference to an account owner.
46
+ Another example of an alias is a username in the FSP system.
47
+ The ALIAS identifier can be in any format. It is also possible to use the
48
+ PartySubIdOrType element for identifying an account under an Alias defined
49
+ by the PartyIdentifier.
50
+ - CONSENT - A Consent represents an agreement between a PISP, a Customer and
51
+ a DFSP which allows the PISP permission to perform actions on behalf of the
52
+ customer. A Consent has an authoritative source: either the DFSP who issued
53
+ the Consent, or an Auth Service which administers the Consent.
54
+ - THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP,
55
+ a DFSP, and a specific Customer's account at the DFSP. The content of the link
56
+ is created by the DFSP at the time when it gives permission to the PISP for
57
+ specific access to a given account.
58
+ example: PERSONAL_ID
@@ -0,0 +1,7 @@
1
+ title: PartyIdTypeTPLink
2
+ type: string
3
+ enum:
4
+ - THIRD_PARTY_LINK
5
+ description: |
6
+ - THIRD_PARTY_LINK - is the DFSP's internal reference which allows DFSP to find out the corresponding consent
7
+ example: PERSONAL_ID
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/PartyIdentifier.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/PartyName.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/PartyPersonalInfo.yaml'
@@ -0,0 +1,10 @@
1
+ title: PartyResult
2
+ type: object
3
+ description: Data model for the complex type PartyResult.
4
+ properties:
5
+ partyId:
6
+ $ref: ./PartyIdInfo.yaml
7
+ errorInformation:
8
+ $ref: ./ErrorInformation.yaml
9
+ required:
10
+ - partyId
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/PartySubIdOrType.yaml'
@@ -0,0 +1,14 @@
1
+ title: Party
2
+ type: object
3
+ description: Data model for the complex type Party.
4
+ properties:
5
+ partyIdInfo:
6
+ $ref: ./PartyIdInfoTPLink.yaml
7
+ merchantClassificationCode:
8
+ $ref: ./MerchantClassificationCode.yaml
9
+ name:
10
+ $ref: ./PartyName.yaml
11
+ personalInfo:
12
+ $ref: ./PartyPersonalInfo.yaml
13
+ required:
14
+ - partyIdInfo
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/QuotesIDPutResponse.yaml'
@@ -0,0 +1,79 @@
1
+ title: QuotesPostRequest
2
+ type: object
3
+ description: The object sent in the POST /quotes request.
4
+ properties:
5
+ quoteId:
6
+ $ref: ./CorrelationId.yaml
7
+ description: >-
8
+ Common ID between the FSPs for the quote object, decided by the Payer FSP.
9
+ The ID should be reused for resends of the same quote for a transaction. A
10
+ new ID should be generated for each new quote for a transaction.
11
+ example: b51ec534-ee48-4575-b6a9-ead2955b8069
12
+ transactionId:
13
+ $ref: ./CorrelationId.yaml
14
+ description: >-
15
+ Common ID (decided by the Payer FSP) between the FSPs for the future
16
+ transaction object. The actual transaction will be created as part of a
17
+ successful transfer process. The ID should be reused for resends of the
18
+ same quote for a transaction. A new ID should be generated for each new
19
+ quote for a transaction.
20
+ example: a8323bc6-c228-4df2-ae82-e5a997baf899
21
+ transactionRequestId:
22
+ $ref: ./CorrelationId.yaml
23
+ description: Identifies an optional previously-sent transaction request.
24
+ example: a8323bc6-c228-4df2-ae82-e5a997baf890
25
+ payee:
26
+ $ref: ./Party.yaml
27
+ description: Information about the Payee in the proposed financial transaction.
28
+ payer:
29
+ $ref: ./Party.yaml
30
+ description: Information about the Payer in the proposed financial transaction.
31
+ amountType:
32
+ $ref: ./AmountType.yaml
33
+ description: 'SEND for send amount, RECEIVE for receive amount.'
34
+ example: SEND
35
+ amount:
36
+ $ref: ./Money.yaml
37
+ description: >-
38
+ Depending on amountType - If SEND - The amount the Payer would like to
39
+ send, that is, the amount that should be withdrawn from the Payer account
40
+ including any fees. The amount is updated by each participating entity in
41
+ the transaction. If RECEIVE - The amount the Payee should receive, that
42
+ is, the amount that should be sent to the receiver exclusive any fees. The
43
+ amount is not updated by any of the participating entities.
44
+ fees:
45
+ $ref: ./Money.yaml
46
+ description: >-
47
+ The fees in the transaction. The fees element should be empty if fees
48
+ should be non-disclosed. The fees element should be non-empty if fees
49
+ should be disclosed.
50
+ transactionType:
51
+ $ref: ./TransactionType.yaml
52
+ description: Type of transaction for which the quote is requested.
53
+ geoCode:
54
+ $ref: ./GeoCode.yaml
55
+ description: >-
56
+ Longitude and Latitude of the initiating Party. Can be used to detect
57
+ fraud.
58
+ note:
59
+ $ref: ./Note.yaml
60
+ description: A memo that will be attached to the transaction.
61
+ example: Free-text memo.
62
+ expiration:
63
+ $ref: ./DateTime.yaml
64
+ description: >-
65
+ Expiration is optional. It can be set to get a quick failure in case the
66
+ peer FSP takes too long to respond. Also, it may be beneficial for
67
+ Consumer, Agent, and Merchant to know that their request has a time limit.
68
+ example: '2016-05-24T08:38:08.699-04:00'
69
+ extensionList:
70
+ $ref: ./ExtensionList.yaml
71
+ description: 'Optional extension, specific to deployment.'
72
+ required:
73
+ - quoteId
74
+ - transactionId
75
+ - payee
76
+ - payer
77
+ - amountType
78
+ - amount
79
+ - transactionType
@@ -0,0 +1,20 @@
1
+ title: Scope
2
+ type: object
3
+ description: >-
4
+ The Scope element contains an identifier defining, in the terms of a DFSP,
5
+ an account on which access types can be requested or granted.
6
+ It also defines the access types which are requested or granted.
7
+
8
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#32121-scope
9
+ properties:
10
+ address:
11
+ $ref: ./AccountAddress.yaml
12
+ actions:
13
+ type: array
14
+ minItems: 1
15
+ maxItems: 32
16
+ items:
17
+ $ref: ./ScopeAction.yaml
18
+ required:
19
+ - address
20
+ - actions
@@ -0,0 +1,14 @@
1
+ title: ScopeAction
2
+ type: string
3
+ description: |
4
+ The ScopeAction element contains an access type which a PISP can request
5
+ from a DFSP, or which a DFSP can grant to a PISP.
6
+ It must be a member of the appropriate enumeration.
7
+
8
+ - ACCOUNTS_GET_BALANCE: PISP can request a balance for the linked account
9
+ - ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the linked account in the DFSP
10
+ - ACCOUNTS_STATEMENT: PISP can request a statement of individual transactions on a user's account
11
+ enum:
12
+ - ACCOUNTS_GET_BALANCE
13
+ - ACCOUNTS_TRANSFER
14
+ - ACCOUNTS_STATEMENT
@@ -0,0 +1,15 @@
1
+ title: ServiceType
2
+ type: string
3
+ description: >-
4
+ The ServiceType enumeration describes the types of role for which a DFSP may query using the /services resource.
5
+
6
+ Below are the allowed values for the enumeration ServiceType
7
+ - THIRD_PARTY_DFSP - Enum used to query for DFSPs that have thirdparty features enabled.
8
+ - PISP - Enum used to query for PISPs.
9
+ - AUTH_SERVICE - Participants which provide Authentication Services.
10
+
11
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#3229-servicetype
12
+ enum:
13
+ - THIRD_PARTY_DFSP
14
+ - PISP
15
+ - AUTH_SERVICE
@@ -0,0 +1,26 @@
1
+ title: ServicesServiceTypePutResponse
2
+ type: object
3
+ description: >-
4
+ Used by: Switch
5
+
6
+ The callback PUT /services/{ServiceType} is used to inform the client of a
7
+ successful result of the service information lookup.
8
+
9
+ Callback and data model information for GET /services/{ServiceType}:
10
+
11
+ Callback - PUT /services/{ServiceType}
12
+ Error Callback - PUT /services/{ServiceType}/error
13
+ Data Model - Empty body
14
+
15
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#31531-put-servicesservicetype
16
+ properties:
17
+ providers:
18
+ type: array
19
+ minLength: 0
20
+ maxLength: 256
21
+ items:
22
+ $ref: ./FspId.yaml
23
+ extensionList:
24
+ $ref: ./ExtensionList.yaml
25
+ required:
26
+ - providers
@@ -0,0 +1,23 @@
1
+ title: SignedCredential
2
+ type: object
3
+ description: |
4
+ A credential used to allow a user to prove their identity and access
5
+ to an account with a DFSP.
6
+
7
+ SignedCredential is a special formatting of the credential to allow us to be
8
+ more explicit about the `status` field - it should only ever be PENDING when
9
+ updating a credential.
10
+ properties:
11
+ credentialType:
12
+ $ref: ./CredentialType.yaml
13
+ # The challenge has signed but not yet verified.
14
+ status:
15
+ $ref: ./CredentialStatusPending.yaml
16
+ genericPayload:
17
+ $ref: ./GenericCredential.yaml
18
+ fidoPayload:
19
+ $ref: ./FIDOPublicKeyCredentialAttestation.yaml
20
+ required:
21
+ - credentialType
22
+ - status
23
+ additionalProperties: false
@@ -0,0 +1,11 @@
1
+ title: SignedPayloadFIDO
2
+ type: object
3
+ properties:
4
+ signedPayloadType:
5
+ $ref: ./SignedPayloadTypeFIDO.yaml
6
+ fidoSignedPayload:
7
+ $ref: ./FIDOPublicKeyCredentialAssertion.yaml
8
+ required:
9
+ - signedPayloadType
10
+ - fidoSignedPayload
11
+ additionalProperties: false
@@ -0,0 +1,11 @@
1
+ title: SignedPayloadGeneric
2
+ type: object
3
+ properties:
4
+ signedPayloadType:
5
+ $ref: ./SignedPayloadTypeGeneric.yaml
6
+ genericSignedPayload:
7
+ $ref: ./BinaryString.yaml
8
+ required:
9
+ - signedPayloadType
10
+ - genericSignedPayload
11
+ additionalProperties: false