@mojaloop/api-snippets 18.3.1 → 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 (216) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/audit-ci.jsonc +7 -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-openapi3-snippets.yaml +5 -5
  7. package/docs/thirdparty-v1.0-openapi3-snippets.yaml +3802 -0
  8. package/docs/thirdparty-v2.0-openapi3-snippets.yaml +1825 -0
  9. package/eslint.config.mjs +70 -0
  10. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +0 -1
  11. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +0 -1
  12. package/lib/fspiop/v2_0/index.js +0 -1
  13. package/lib/fspiop/v2_0/index.js.map +1 -1
  14. package/lib/fspiop/v2_0_ISO20022/index.js +0 -1
  15. package/lib/fspiop/v2_0_ISO20022/index.js.map +1 -1
  16. package/lib/fspiop/v2_0_ISO20022/json-schemas.json +0 -71
  17. package/lib/fspiop/v2_0_ISO20022/schemas.d.ts +0 -140
  18. package/lib/index.js +0 -1
  19. package/lib/index.js.map +1 -1
  20. package/lib/sdk-scheme-adapter/v2_0_0/backend/index.js +0 -1
  21. package/lib/sdk-scheme-adapter/v2_0_0/backend/index.js.map +1 -1
  22. package/lib/sdk-scheme-adapter/v2_0_0/outbound/index.js +0 -1
  23. package/lib/sdk-scheme-adapter/v2_0_0/outbound/index.js.map +1 -1
  24. package/lib/sdk-scheme-adapter/v2_1_0/backend/index.js +0 -1
  25. package/lib/sdk-scheme-adapter/v2_1_0/backend/index.js.map +1 -1
  26. package/lib/sdk-scheme-adapter/v2_1_0/outbound/index.js +0 -1
  27. package/lib/sdk-scheme-adapter/v2_1_0/outbound/index.js.map +1 -1
  28. package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +1 -1
  29. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +1 -1
  30. package/lib/thirdparty/v2_0/openapi.d.ts +1726 -0
  31. package/lib/thirdparty/v2_0/openapi.js +7 -0
  32. package/lib/thirdparty/v2_0/openapi.js.map +1 -0
  33. package/package.json +48 -45
  34. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferRequest.yaml +1 -1
  35. package/test/dto/{thirdparty.test.ts → thirdparty_v1_0.test.ts} +1 -1
  36. package/thirdparty/v1_0/openapi3/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +2 -2
  37. package/thirdparty/v1_0/openapi3/components/schemas/FIDOPublicKeyCredentialAttestation.yaml +3 -3
  38. package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml +68 -61
  39. package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml +82 -75
  40. package/thirdparty/v2_0/openapi3/components/headers/Content-Length.yaml +1 -0
  41. package/thirdparty/v2_0/openapi3/components/headers/Content-Type.yaml +1 -0
  42. package/thirdparty/v2_0/openapi3/components/parameters/Accept.yaml +1 -0
  43. package/thirdparty/v2_0/openapi3/components/parameters/Content-Length.yaml +1 -0
  44. package/thirdparty/v2_0/openapi3/components/parameters/Content-Type.yaml +1 -0
  45. package/thirdparty/v2_0/openapi3/components/parameters/Date.yaml +1 -0
  46. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Destination.yaml +1 -0
  47. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Encryption.yaml +1 -0
  48. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -0
  49. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Signature.yaml +1 -0
  50. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Source.yaml +1 -0
  51. package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-URI.yaml +1 -0
  52. package/thirdparty/v2_0/openapi3/components/parameters/ID.yaml +1 -0
  53. package/thirdparty/v2_0/openapi3/components/parameters/ServiceType.yaml +6 -0
  54. package/thirdparty/v2_0/openapi3/components/parameters/SubId.yaml +1 -0
  55. package/thirdparty/v2_0/openapi3/components/parameters/Type.yaml +1 -0
  56. package/thirdparty/v2_0/openapi3/components/parameters/X-Forwarded-For.yaml +1 -0
  57. package/thirdparty/v2_0/openapi3/components/responses/200.yaml +1 -0
  58. package/thirdparty/v2_0/openapi3/components/responses/202.yaml +1 -0
  59. package/thirdparty/v2_0/openapi3/components/responses/400.yaml +1 -0
  60. package/thirdparty/v2_0/openapi3/components/responses/401.yaml +1 -0
  61. package/thirdparty/v2_0/openapi3/components/responses/403.yaml +1 -0
  62. package/thirdparty/v2_0/openapi3/components/responses/404.yaml +1 -0
  63. package/thirdparty/v2_0/openapi3/components/responses/405.yaml +1 -0
  64. package/thirdparty/v2_0/openapi3/components/responses/406.yaml +1 -0
  65. package/thirdparty/v2_0/openapi3/components/responses/501.yaml +1 -0
  66. package/thirdparty/v2_0/openapi3/components/responses/503.yaml +1 -0
  67. package/thirdparty/v2_0/openapi3/components/schemas/Account.yaml +17 -0
  68. package/thirdparty/v2_0/openapi3/components/schemas/AccountAddress.yaml +25 -0
  69. package/thirdparty/v2_0/openapi3/components/schemas/AccountList.yaml +11 -0
  70. package/thirdparty/v2_0/openapi3/components/schemas/Amount.yaml +1 -0
  71. package/thirdparty/v2_0/openapi3/components/schemas/AmountType.yaml +1 -0
  72. package/thirdparty/v2_0/openapi3/components/schemas/AuthenticationResponse.yaml +10 -0
  73. package/thirdparty/v2_0/openapi3/components/schemas/AuthenticatorAssertionResponse.yaml +32 -0
  74. package/thirdparty/v2_0/openapi3/components/schemas/AuthenticatorAttestationResponse.yaml +23 -0
  75. package/thirdparty/v2_0/openapi3/components/schemas/AuthorizationResponseType.yaml +8 -0
  76. package/thirdparty/v2_0/openapi3/components/schemas/AuthorizationResponseTypeAccepted.yaml +6 -0
  77. package/thirdparty/v2_0/openapi3/components/schemas/AuthorizationResponseTypeRejected.yaml +6 -0
  78. package/thirdparty/v2_0/openapi3/components/schemas/BinaryString.yaml +1 -0
  79. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestChannelType.yaml +9 -0
  80. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestChannelTypeOTP.yaml +6 -0
  81. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestChannelTypeWeb.yaml +6 -0
  82. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsIDPatchRequest.yaml +16 -0
  83. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsIDPutResponseOTP.yaml +30 -0
  84. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsIDPutResponseWeb.yaml +39 -0
  85. package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsPostRequest.yaml +44 -0
  86. package/thirdparty/v2_0/openapi3/components/schemas/ConsentStatus.yaml +9 -0
  87. package/thirdparty/v2_0/openapi3/components/schemas/ConsentStatusIssued.yaml +7 -0
  88. package/thirdparty/v2_0/openapi3/components/schemas/ConsentStatusRevoked.yaml +7 -0
  89. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPatchResponseRevoked.yaml +17 -0
  90. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPatchResponseVerified.yaml +19 -0
  91. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPutResponseSigned.yaml +23 -0
  92. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPutResponseVerified.yaml +23 -0
  93. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsPostRequestAUTH.yaml +33 -0
  94. package/thirdparty/v2_0/openapi3/components/schemas/ConsentsPostRequestPISP.yaml +32 -0
  95. package/thirdparty/v2_0/openapi3/components/schemas/CorrelationId.yaml +1 -0
  96. package/thirdparty/v2_0/openapi3/components/schemas/CredentialStatusPending.yaml +7 -0
  97. package/thirdparty/v2_0/openapi3/components/schemas/CredentialStatusVerified.yaml +7 -0
  98. package/thirdparty/v2_0/openapi3/components/schemas/CredentialType.yaml +11 -0
  99. package/thirdparty/v2_0/openapi3/components/schemas/Currency.yaml +1 -0
  100. package/thirdparty/v2_0/openapi3/components/schemas/DateOfBirth.yaml +1 -0
  101. package/thirdparty/v2_0/openapi3/components/schemas/DateTime.yaml +1 -0
  102. package/thirdparty/v2_0/openapi3/components/schemas/ErrorCode.yaml +1 -0
  103. package/thirdparty/v2_0/openapi3/components/schemas/ErrorDescription.yaml +1 -0
  104. package/thirdparty/v2_0/openapi3/components/schemas/ErrorInformation.yaml +1 -0
  105. package/thirdparty/v2_0/openapi3/components/schemas/Extension.yaml +1 -0
  106. package/thirdparty/v2_0/openapi3/components/schemas/ExtensionKey.yaml +1 -0
  107. package/thirdparty/v2_0/openapi3/components/schemas/ExtensionList.yaml +1 -0
  108. package/thirdparty/v2_0/openapi3/components/schemas/ExtensionValue.yaml +1 -0
  109. package/thirdparty/v2_0/openapi3/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +71 -0
  110. package/thirdparty/v2_0/openapi3/components/schemas/FIDOPublicKeyCredentialAttestation.yaml +54 -0
  111. package/thirdparty/v2_0/openapi3/components/schemas/FirstName.yaml +1 -0
  112. package/thirdparty/v2_0/openapi3/components/schemas/FspId.yaml +1 -0
  113. package/thirdparty/v2_0/openapi3/components/schemas/GenericCredential.yaml +13 -0
  114. package/thirdparty/v2_0/openapi3/components/schemas/GeoCode.yaml +1 -0
  115. package/thirdparty/v2_0/openapi3/components/schemas/IlpCondition.yaml +1 -0
  116. package/thirdparty/v2_0/openapi3/components/schemas/IlpFulfilment.yaml +1 -0
  117. package/thirdparty/v2_0/openapi3/components/schemas/IlpPacket.yaml +1 -0
  118. package/thirdparty/v2_0/openapi3/components/schemas/Integer.yaml +1 -0
  119. package/thirdparty/v2_0/openapi3/components/schemas/LastName.yaml +1 -0
  120. package/thirdparty/v2_0/openapi3/components/schemas/Latitude.yaml +1 -0
  121. package/thirdparty/v2_0/openapi3/components/schemas/Longitude.yaml +1 -0
  122. package/thirdparty/v2_0/openapi3/components/schemas/MerchantClassificationCode.yaml +1 -0
  123. package/thirdparty/v2_0/openapi3/components/schemas/MiddleName.yaml +1 -0
  124. package/thirdparty/v2_0/openapi3/components/schemas/Money.yaml +1 -0
  125. package/thirdparty/v2_0/openapi3/components/schemas/Name.yaml +2 -0
  126. package/thirdparty/v2_0/openapi3/components/schemas/Note.yaml +1 -0
  127. package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsIDPutResponse.yaml +17 -0
  128. package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsPostRequest.yaml +20 -0
  129. package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsTypeIDPutResponse.yaml +8 -0
  130. package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml +15 -0
  131. package/thirdparty/v2_0/openapi3/components/schemas/PartiesTypeIDPutResponse.yaml +13 -0
  132. package/thirdparty/v2_0/openapi3/components/schemas/Party.yaml +15 -0
  133. package/thirdparty/v2_0/openapi3/components/schemas/PartyComplexName.yaml +1 -0
  134. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdInfo.yaml +17 -0
  135. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdInfoTPLink.yaml +17 -0
  136. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdType.yaml +58 -0
  137. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdTypeTPLink.yaml +7 -0
  138. package/thirdparty/v2_0/openapi3/components/schemas/PartyIdentifier.yaml +1 -0
  139. package/thirdparty/v2_0/openapi3/components/schemas/PartyName.yaml +1 -0
  140. package/thirdparty/v2_0/openapi3/components/schemas/PartyPersonalInfo.yaml +1 -0
  141. package/thirdparty/v2_0/openapi3/components/schemas/PartyResult.yaml +10 -0
  142. package/thirdparty/v2_0/openapi3/components/schemas/PartySubIdOrType.yaml +1 -0
  143. package/thirdparty/v2_0/openapi3/components/schemas/PartyTPLink.yaml +14 -0
  144. package/thirdparty/v2_0/openapi3/components/schemas/QuotesIDPutResponse.yaml +1 -0
  145. package/thirdparty/v2_0/openapi3/components/schemas/QuotesPostRequest.yaml +79 -0
  146. package/thirdparty/v2_0/openapi3/components/schemas/Scope.yaml +20 -0
  147. package/thirdparty/v2_0/openapi3/components/schemas/ScopeAction.yaml +14 -0
  148. package/thirdparty/v2_0/openapi3/components/schemas/ServiceType.yaml +15 -0
  149. package/thirdparty/v2_0/openapi3/components/schemas/ServicesServiceTypePutResponse.yaml +26 -0
  150. package/thirdparty/v2_0/openapi3/components/schemas/SignedCredential.yaml +23 -0
  151. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadFIDO.yaml +11 -0
  152. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadGeneric.yaml +11 -0
  153. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadType.yaml +9 -0
  154. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadTypeFIDO.yaml +5 -0
  155. package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadTypeGeneric.yaml +5 -0
  156. package/thirdparty/v2_0/openapi3/components/schemas/Transaction.yaml +43 -0
  157. package/thirdparty/v2_0/openapi3/components/schemas/TransactionRequestState.yaml +1 -0
  158. package/thirdparty/v2_0/openapi3/components/schemas/TransactionState.yaml +1 -0
  159. package/thirdparty/v2_0/openapi3/components/schemas/TransactionType.yaml +1 -0
  160. package/thirdparty/v2_0/openapi3/components/schemas/TransfersPostRequestFIDO.yaml +15 -0
  161. package/thirdparty/v2_0/openapi3/components/schemas/TransfersPostRequestGeneric.yaml +15 -0
  162. package/thirdparty/v2_0/openapi3/components/schemas/Uri.yaml +8 -0
  163. package/thirdparty/v2_0/openapi3/components/schemas/VerifiedCredential.yaml +23 -0
  164. package/thirdparty/v2_0/openapi3/components/schemas/tppAccountRequestPostRequest.yaml +35 -0
  165. package/thirdparty/v2_0/openapi3/components/schemas/tppAccountRequestPutResponse.yaml +30 -0
  166. package/thirdparty/v2_0/openapi3/components/schemas/tppAccountsIDPutResponse.yaml +21 -0
  167. package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseFIDO.yaml +15 -0
  168. package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseGeneric.yaml +15 -0
  169. package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseRejected.yaml +10 -0
  170. package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsPostRequest.yaml +67 -0
  171. package/thirdparty/v2_0/openapi3/components/schemas/tppTransactionRequestPostRequest.yaml +60 -0
  172. package/thirdparty/v2_0/openapi3/components/schemas/tppTransactionRequestPutResponse.yaml +67 -0
  173. package/thirdparty/v2_0/openapi3/components/schemas/tppTransfersPostRequest.yaml +19 -0
  174. package/thirdparty/v2_0/openapi3/components/schemas/tppTransfersPutResponse.yaml +25 -0
  175. package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsIDPutResponse.yaml +19 -0
  176. package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsPostRequestFIDO.yaml +28 -0
  177. package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsPostRequestGeneric.yaml +28 -0
  178. package/thirdparty/v2_0/openapi3/openapi-admin.yaml +99 -0
  179. package/thirdparty/v2_0/openapi3/openapi.yaml +64 -0
  180. package/thirdparty/v2_0/openapi3/paths/health.yaml +25 -0
  181. package/thirdparty/v2_0/openapi3/paths/metrics.yaml +25 -0
  182. package/thirdparty/v2_0/openapi3/paths/participants.yaml +50 -0
  183. package/thirdparty/v2_0/openapi3/paths/participants_ID.yaml +49 -0
  184. package/thirdparty/v2_0/openapi3/paths/participants_ID_error.yaml +51 -0
  185. package/thirdparty/v2_0/openapi3/paths/participants_Type_ID.yaml +169 -0
  186. package/thirdparty/v2_0/openapi3/paths/participants_Type_ID_error.yaml +52 -0
  187. package/thirdparty/v2_0/openapi3/paths/services_ServiceType.yaml +77 -0
  188. package/thirdparty/v2_0/openapi3/paths/services_ServiceType_error.yaml +49 -0
  189. package/thirdparty/v2_0/openapi3/paths/tppAccountRequest.yaml +49 -0
  190. package/thirdparty/v2_0/openapi3/paths/tppAccountRequest_ID.yaml +86 -0
  191. package/thirdparty/v2_0/openapi3/paths/tppAccountRequest_ID_error.yaml +48 -0
  192. package/thirdparty/v2_0/openapi3/paths/tppAccounts_ID.yaml +88 -0
  193. package/thirdparty/v2_0/openapi3/paths/tppAccounts_ID_error.yaml +48 -0
  194. package/thirdparty/v2_0/openapi3/paths/tppAuthorizations.yaml +51 -0
  195. package/thirdparty/v2_0/openapi3/paths/tppAuthorizations_ID.yaml +86 -0
  196. package/thirdparty/v2_0/openapi3/paths/tppAuthorizations_ID_error.yaml +55 -0
  197. package/thirdparty/v2_0/openapi3/paths/tppConsentRequests.yaml +48 -0
  198. package/thirdparty/v2_0/openapi3/paths/tppConsentRequests_ID.yaml +123 -0
  199. package/thirdparty/v2_0/openapi3/paths/tppConsentRequests_ID_error.yaml +48 -0
  200. package/thirdparty/v2_0/openapi3/paths/tppConsents.yaml +49 -0
  201. package/thirdparty/v2_0/openapi3/paths/tppConsents_ID.yaml +165 -0
  202. package/thirdparty/v2_0/openapi3/paths/tppConsents_ID_error.yaml +48 -0
  203. package/thirdparty/v2_0/openapi3/paths/tppTransactionRequests.yaml +48 -0
  204. package/thirdparty/v2_0/openapi3/paths/tppTransactionRequests_ID.yaml +83 -0
  205. package/thirdparty/v2_0/openapi3/paths/tppTransactionRequests_ID_error.yaml +52 -0
  206. package/thirdparty/v2_0/openapi3/paths/tppTransfers.yaml +47 -0
  207. package/thirdparty/v2_0/openapi3/paths/tppTransfers_ID.yaml +86 -0
  208. package/thirdparty/v2_0/openapi3/paths/tppTransfers_ID_error.yaml +52 -0
  209. package/thirdparty/v2_0/openapi3/paths/tppVerifications.yaml +49 -0
  210. package/thirdparty/v2_0/openapi3/paths/tppVerifications_ID.yaml +87 -0
  211. package/thirdparty/v2_0/openapi3/paths/tppVerifications_ID_error.yaml +49 -0
  212. package/thirdparty/v2_0/openapi3/thirdparty-dfsp-admin-api.template.yaml +53 -0
  213. package/thirdparty/v2_0/openapi3/thirdparty-dfsp-admin-api.yaml +2633 -0
  214. package/thirdparty/v2_0/openapi3/thirdparty-pisp-admin-api.template.yaml +57 -0
  215. package/thirdparty/v2_0/openapi3/thirdparty-pisp-admin-api.yaml +3103 -0
  216. package/tsconfig.build.json +4 -3
@@ -7,11 +7,11 @@ info:
7
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
- url: 'https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md'
10
+ url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
11
11
  servers:
12
12
  - url: /
13
13
  paths:
14
- '/accounts/{ID}':
14
+ /accounts/{ID}:
15
15
  parameters:
16
16
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
17
17
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -75,7 +75,7 @@ paths:
75
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
76
  https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
77
77
  properties:
78
- accountList:
78
+ accounts:
79
79
  title: AccountList
80
80
  type: array
81
81
  description: |-
@@ -91,7 +91,7 @@ paths:
91
91
  accountNickname:
92
92
  title: Name
93
93
  type: string
94
- pattern: '^(?!\s*$)[\w .,''-]{1,128}$'
94
+ pattern: ^(?!\s*$)[\w .,'-]{1,128}$
95
95
  description: |-
96
96
  The API data type Name is a JSON String, restricted by a regular expression to avoid characters which are generally not used in a name.
97
97
 
@@ -138,7 +138,7 @@ paths:
138
138
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
139
139
  '503':
140
140
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
141
- '/accounts/{ID}/error':
141
+ /accounts/{ID}/error:
142
142
  parameters:
143
143
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
144
144
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -178,8 +178,8 @@ paths:
178
178
  errorCode:
179
179
  title: ErrorCode
180
180
  type: string
181
- pattern: '^[1-9]\d{3}$'
182
- description: 'The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.'
181
+ pattern: ^[1-9]\d{3}$
182
+ description: The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.
183
183
  example: '5100'
184
184
  errorDescription:
185
185
  title: ErrorDescription
@@ -254,12 +254,12 @@ paths:
254
254
  consentRequestId:
255
255
  title: CorrelationId
256
256
  type: string
257
- pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
258
- description: 'Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).'
257
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
258
+ description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
259
259
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
260
260
  userId:
261
261
  type: string
262
- description: 'The identifier used in the **GET /accounts/**_{ID}_. Used by the DFSP to correlate an account lookup to a `consentRequest`'
262
+ description: The identifier used in the **GET /accounts/**_{ID}_. Used by the DFSP to correlate an account lookup to a `consentRequest`
263
263
  minLength: 1
264
264
  maxLength: 128
265
265
  scopes:
@@ -283,7 +283,7 @@ paths:
283
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
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
285
  https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
286
- pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
286
+ pattern: ^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$
287
287
  minLength: 1
288
288
  maxLength: 1023
289
289
  actions:
@@ -325,7 +325,7 @@ paths:
325
325
  callbackUri:
326
326
  title: Uri
327
327
  type: string
328
- pattern: '^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?'
328
+ pattern: ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?
329
329
  minLength: 1
330
330
  maxLength: 512
331
331
  description: |
@@ -333,7 +333,7 @@ paths:
333
333
  extensionList:
334
334
  title: ExtensionList
335
335
  type: object
336
- description: 'Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.'
336
+ description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
337
337
  properties:
338
338
  extension:
339
339
  type: array
@@ -387,7 +387,7 @@ paths:
387
387
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
388
388
  '503':
389
389
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
390
- '/consentRequests/{ID}':
390
+ /consentRequests/{ID}:
391
391
  parameters:
392
392
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
393
393
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -569,8 +569,8 @@ paths:
569
569
  properties:
570
570
  authToken:
571
571
  type: string
572
- pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
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.'
572
+ pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
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
574
  extensionList:
575
575
  $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
576
576
  required:
@@ -594,7 +594,7 @@ paths:
594
594
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
595
595
  '503':
596
596
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
597
- '/consentRequests/{ID}/error':
597
+ /consentRequests/{ID}/error:
598
598
  parameters:
599
599
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
600
600
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -609,6 +609,7 @@ paths:
609
609
  put:
610
610
  tags:
611
611
  - consentRequests
612
+ - sampled
612
613
  operationId: NotifyErrorConsentRequests
613
614
  summary: NotifyErrorConsentRequests
614
615
  description: |
@@ -761,7 +762,7 @@ paths:
761
762
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
762
763
  '503':
763
764
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
764
- '/consents/{ID}':
765
+ /consents/{ID}:
765
766
  parameters:
766
767
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
767
768
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -988,13 +989,13 @@ paths:
988
989
  description: |
989
990
  credential id: identifier of pair of keys, base64 encoded
990
991
  https://w3c.github.io/webauthn/#ref-for-dom-credential-id
991
- minLength: 59
992
+ minLength: 20
992
993
  maxLength: 118
993
994
  rawId:
994
995
  type: string
995
996
  description: |
996
997
  raw credential id: identifier of pair of keys, base64 encoded
997
- minLength: 59
998
+ minLength: 20
998
999
  maxLength: 118
999
1000
  response:
1000
1001
  type: object
@@ -1019,7 +1020,7 @@ paths:
1019
1020
  additionalProperties: false
1020
1021
  type:
1021
1022
  type: string
1022
- description: 'response type, we need only the type of public-key'
1023
+ description: response type, we need only the type of public-key
1023
1024
  enum:
1024
1025
  - public-key
1025
1026
  required:
@@ -1133,7 +1134,7 @@ paths:
1133
1134
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
1134
1135
  '503':
1135
1136
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
1136
- '/consents/{ID}/error':
1137
+ /consents/{ID}/error:
1137
1138
  parameters:
1138
1139
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
1139
1140
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -1148,6 +1149,7 @@ paths:
1148
1149
  put:
1149
1150
  tags:
1150
1151
  - consents
1152
+ - sampled
1151
1153
  operationId: NotifyErrorConsents
1152
1154
  summary: NotifyErrorConsents
1153
1155
  description: |
@@ -1198,6 +1200,7 @@ paths:
1198
1200
  summary: PostThirdpartyRequestsAuthorizations
1199
1201
  tags:
1200
1202
  - authorizations
1203
+ - sampled
1201
1204
  parameters:
1202
1205
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/parameters/0'
1203
1206
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/put/parameters/0'
@@ -1238,7 +1241,7 @@ paths:
1238
1241
  payer:
1239
1242
  allOf:
1240
1243
  - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payer/allOf/0'
1241
- description: 'Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.'
1244
+ description: Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.
1242
1245
  payee:
1243
1246
  allOf:
1244
1247
  - $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payee/allOf/0'
@@ -1268,8 +1271,8 @@ paths:
1268
1271
  subScenario:
1269
1272
  title: TransactionSubScenario
1270
1273
  type: string
1271
- pattern: '^[A-Z_]{1,32}$'
1272
- description: 'Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).'
1274
+ pattern: ^[A-Z_]{1,32}$
1275
+ description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
1273
1276
  example: LOCALLY_DEFINED_SUBSCENARIO
1274
1277
  initiator:
1275
1278
  title: TransactionInitiator
@@ -1316,8 +1319,8 @@ paths:
1316
1319
  balanceOfPayments:
1317
1320
  title: BalanceOfPayments
1318
1321
  type: string
1319
- pattern: '^[1-9]\d{2}$'
1320
- description: '(BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed.'
1322
+ pattern: ^[1-9]\d{2}$
1323
+ description: (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed.
1321
1324
  example: '123'
1322
1325
  required:
1323
1326
  - scenario
@@ -1326,7 +1329,7 @@ paths:
1326
1329
  expiration:
1327
1330
  allOf:
1328
1331
  - $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/completedTimestamp'
1329
- description: 'The time by which the transfer must be completed, set by the payee DFSP.'
1332
+ description: The time by which the transfer must be completed, set by the payee DFSP.
1330
1333
  extensionList:
1331
1334
  $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
1332
1335
  required:
@@ -1360,7 +1363,7 @@ paths:
1360
1363
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
1361
1364
  '503':
1362
1365
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
1363
- '/thirdpartyRequests/authorizations/{ID}':
1366
+ /thirdpartyRequests/authorizations/{ID}:
1364
1367
  parameters:
1365
1368
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
1366
1369
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -1381,6 +1384,7 @@ paths:
1381
1384
  summary: GetThirdpartyRequestsAuthorizationsById
1382
1385
  tags:
1383
1386
  - authorizations
1387
+ - sampled
1384
1388
  parameters:
1385
1389
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/parameters/0'
1386
1390
  responses:
@@ -1424,7 +1428,7 @@ paths:
1424
1428
  oneOf:
1425
1429
  - title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
1426
1430
  type: object
1427
- description: 'The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.'
1431
+ description: The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.
1428
1432
  properties:
1429
1433
  responseType:
1430
1434
  title: AuthorizationResponseTypeRejected
@@ -1439,7 +1443,7 @@ paths:
1439
1443
  - responseType
1440
1444
  - title: ThirdpartyRequestsAuthorizationsIDPutResponseFIDO
1441
1445
  type: object
1442
- description: 'The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.'
1446
+ description: The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.
1443
1447
  properties:
1444
1448
  responseType:
1445
1449
  title: AuthorizationResponseType
@@ -1476,13 +1480,13 @@ paths:
1476
1480
  description: |
1477
1481
  credential id: identifier of pair of keys, base64 encoded
1478
1482
  https://w3c.github.io/webauthn/#ref-for-dom-credential-id
1479
- minLength: 59
1483
+ minLength: 20
1480
1484
  maxLength: 118
1481
1485
  rawId:
1482
1486
  type: string
1483
1487
  description: |
1484
1488
  raw credential id: identifier of pair of keys, base64 encoded.
1485
- minLength: 59
1489
+ minLength: 20
1486
1490
  maxLength: 118
1487
1491
  response:
1488
1492
  type: object
@@ -1521,7 +1525,7 @@ paths:
1521
1525
  additionalProperties: false
1522
1526
  type:
1523
1527
  type: string
1524
- description: 'response type, we need only the type of public-key'
1528
+ description: response type, we need only the type of public-key
1525
1529
  enum:
1526
1530
  - public-key
1527
1531
  required:
@@ -1542,7 +1546,7 @@ paths:
1542
1546
  additionalProperties: false
1543
1547
  - title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
1544
1548
  type: object
1545
- description: 'The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.'
1549
+ description: The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.
1546
1550
  properties:
1547
1551
  responseType:
1548
1552
  $ref: '#/paths/~1thirdpartyRequests~1authorizations~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/1/properties/responseType'
@@ -1587,7 +1591,7 @@ paths:
1587
1591
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
1588
1592
  '503':
1589
1593
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
1590
- '/thirdpartyRequests/authorizations/{ID}/error':
1594
+ /thirdpartyRequests/authorizations/{ID}/error:
1591
1595
  parameters:
1592
1596
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
1593
1597
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -1659,6 +1663,7 @@ paths:
1659
1663
  description: The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
1660
1664
  tags:
1661
1665
  - thirdpartyRequests
1666
+ - sampled
1662
1667
  parameters:
1663
1668
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/parameters/0'
1664
1669
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/put/parameters/0'
@@ -1732,7 +1737,7 @@ paths:
1732
1737
  [RFC 3696](https://tools.ietf.org/html/rfc3696).
1733
1738
  - PERSONAL_ID - A personal identifier is used as reference to a participant.
1734
1739
  Examples of personal identification are passport number, birth certificate
1735
- number, and national registration number. The identifier number is added in
1740
+ number, and national registration number. The identifier number is added in
1736
1741
  the PartyIdentifier element. The personal identifier type is added in the
1737
1742
  PartySubIdOrType element.
1738
1743
  - BUSINESS - A specific Business (for example, an organization or a company)
@@ -1756,12 +1761,12 @@ paths:
1756
1761
  PartySubIdOrType element for identifying an account under an Alias defined
1757
1762
  by the PartyIdentifier.
1758
1763
  - CONSENT - A Consent represents an agreement between a PISP, a Customer and
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
1764
+ a DFSP which allows the PISP permission to perform actions on behalf of the
1765
+ customer. A Consent has an authoritative source: either the DFSP who issued
1761
1766
  the Consent, or an Auth Service which administers the Consent.
1762
1767
  - THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP,
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
1768
+ a DFSP, and a specific Customer's account at the DFSP. The content of the link
1769
+ is created by the DFSP at the time when it gives permission to the PISP for
1765
1770
  specific access to a given account.
1766
1771
  example: PERSONAL_ID
1767
1772
  partyIdentifier:
@@ -1776,7 +1781,7 @@ paths:
1776
1781
  type: string
1777
1782
  minLength: 1
1778
1783
  maxLength: 128
1779
- description: 'Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.'
1784
+ description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
1780
1785
  fspId:
1781
1786
  $ref: '#/paths/~1services~1%7BServiceType%7D/put/requestBody/content/application~1json/schema/properties/providers/items'
1782
1787
  extensionList:
@@ -1797,7 +1802,7 @@ paths:
1797
1802
  - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
1798
1803
  - RECEIVE - Amount the Payer would like the Payee to receive, that is, the amount that should be sent to the receiver exclusive of any fees.
1799
1804
  example: RECEIVE
1800
- description: 'SEND for sendAmount, RECEIVE for receiveAmount.'
1805
+ description: SEND for sendAmount, RECEIVE for receiveAmount.
1801
1806
  amount:
1802
1807
  allOf:
1803
1808
  - title: Money
@@ -1806,7 +1811,7 @@ paths:
1806
1811
  properties:
1807
1812
  currency:
1808
1813
  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.'
1814
+ 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
1815
  type: string
1811
1816
  minLength: 3
1812
1817
  maxLength: 3
@@ -1978,8 +1983,8 @@ paths:
1978
1983
  amount:
1979
1984
  title: Amount
1980
1985
  type: string
1981
- pattern: '^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$'
1982
- description: 'The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed.'
1986
+ pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1987
+ description: The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed.
1983
1988
  example: '123.45'
1984
1989
  required:
1985
1990
  - currency
@@ -2028,7 +2033,7 @@ paths:
2028
2033
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
2029
2034
  '503':
2030
2035
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
2031
- '/thirdpartyRequests/transactions/{ID}':
2036
+ /thirdpartyRequests/transactions/{ID}:
2032
2037
  parameters:
2033
2038
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
2034
2039
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -2095,6 +2100,8 @@ paths:
2095
2100
  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
2101
  https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
2097
2102
  properties:
2103
+ transactionId:
2104
+ $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
2098
2105
  transactionRequestState:
2099
2106
  title: TransactionRequestState
2100
2107
  type: string
@@ -2165,8 +2172,8 @@ paths:
2165
2172
  completedTimestamp:
2166
2173
  title: DateTime
2167
2174
  type: string
2168
- pattern: '^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$'
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).'
2175
+ pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
2176
+ 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).
2170
2177
  example: '2016-05-24T08:38:08.699-04:00'
2171
2178
  transactionRequestState:
2172
2179
  $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/put/requestBody/content/application~1json/schema/properties/transactionRequestState'
@@ -2212,7 +2219,7 @@ paths:
2212
2219
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
2213
2220
  '503':
2214
2221
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
2215
- '/thirdpartyRequests/transactions/{ID}/error':
2222
+ /thirdpartyRequests/transactions/{ID}/error:
2216
2223
  parameters:
2217
2224
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
2218
2225
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -2263,14 +2270,14 @@ paths:
2263
2270
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
2264
2271
  '503':
2265
2272
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
2266
- '/parties/{Type}/{ID}':
2273
+ /parties/{Type}/{ID}:
2267
2274
  parameters:
2268
2275
  - name: Type
2269
2276
  in: path
2270
2277
  required: true
2271
2278
  schema:
2272
2279
  type: string
2273
- description: 'The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.'
2280
+ description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
2274
2281
  - name: ID
2275
2282
  in: path
2276
2283
  required: true
@@ -2309,7 +2316,7 @@ paths:
2309
2316
  schema:
2310
2317
  type: string
2311
2318
  required: false
2312
- description: 'The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty.'
2319
+ description: The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty.
2313
2320
  - name: FSPIOP-Encryption
2314
2321
  in: header
2315
2322
  schema:
@@ -2327,15 +2334,15 @@ paths:
2327
2334
  schema:
2328
2335
  type: string
2329
2336
  required: false
2330
- description: 'The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
2337
+ description: The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
2331
2338
  - name: FSPIOP-HTTP-Method
2332
2339
  in: header
2333
2340
  schema:
2334
2341
  type: string
2335
2342
  required: false
2336
- description: 'The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
2343
+ description: The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
2337
2344
  get:
2338
- description: 'The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).'
2345
+ description: The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
2339
2346
  summary: Look up party information
2340
2347
  tags:
2341
2348
  - parties
@@ -2453,7 +2460,7 @@ paths:
2453
2460
  Content-Type:
2454
2461
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/400/headers/Content-Type'
2455
2462
  put:
2456
- description: 'The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.'
2463
+ description: The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
2457
2464
  summary: Return party information
2458
2465
  tags:
2459
2466
  - parties
@@ -2476,7 +2483,7 @@ paths:
2476
2483
  schema:
2477
2484
  title: PartiesTypeIDPutResponse
2478
2485
  type: object
2479
- description: 'The object sent in the PUT /parties/{Type}/{ID} callback.'
2486
+ description: The object sent in the PUT /parties/{Type}/{ID} callback.
2480
2487
  properties:
2481
2488
  party:
2482
2489
  title: Party
@@ -2524,8 +2531,8 @@ paths:
2524
2531
  merchantClassificationCode:
2525
2532
  title: MerchantClassificationCode
2526
2533
  type: string
2527
- pattern: '^[\d]{1,4}$'
2528
- description: 'A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.'
2534
+ pattern: ^[\d]{1,4}$
2535
+ description: A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.
2529
2536
  name:
2530
2537
  title: PartyName
2531
2538
  type: string
@@ -2547,7 +2554,7 @@ paths:
2547
2554
  type: string
2548
2555
  minLength: 1
2549
2556
  maxLength: 128
2550
- pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''''-]{1,128}$'
2557
+ pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
2551
2558
  description: First name of the Party (Name Type).
2552
2559
  example: Henrik
2553
2560
  middleName:
@@ -2555,7 +2562,7 @@ paths:
2555
2562
  type: string
2556
2563
  minLength: 1
2557
2564
  maxLength: 128
2558
- pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''''-]{1,128}$'
2565
+ pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
2559
2566
  description: Middle name of the Party (Name Type).
2560
2567
  example: Johannes
2561
2568
  lastName:
@@ -2563,13 +2570,13 @@ paths:
2563
2570
  type: string
2564
2571
  minLength: 1
2565
2572
  maxLength: 128
2566
- pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''''-]{1,128}$'
2573
+ pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
2567
2574
  description: Last name of the Party (Name Type).
2568
2575
  example: Karlsson
2569
2576
  dateOfBirth:
2570
2577
  title: DateofBirth (type Date)
2571
2578
  type: string
2572
- pattern: '^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$'
2579
+ pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
2573
2580
  description: Date of Birth of the Party.
2574
2581
  example: '1966-06-16'
2575
2582
  required:
@@ -2595,9 +2602,9 @@ paths:
2595
2602
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
2596
2603
  '503':
2597
2604
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
2598
- '/parties/{Type}/{ID}/error':
2605
+ /parties/{Type}/{ID}/error:
2599
2606
  put:
2600
- description: 'If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used.'
2607
+ description: If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used.
2601
2608
  summary: Return party information error
2602
2609
  tags:
2603
2610
  - parties
@@ -2641,7 +2648,7 @@ paths:
2641
2648
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
2642
2649
  '503':
2643
2650
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
2644
- '/parties/{Type}/{ID}/{SubId}':
2651
+ /parties/{Type}/{ID}/{SubId}:
2645
2652
  parameters:
2646
2653
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/0'
2647
2654
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/1'
@@ -2650,7 +2657,7 @@ paths:
2650
2657
  required: true
2651
2658
  schema:
2652
2659
  type: string
2653
- description: 'A sub-identifier of the party identifier, or a sub-type of the party identifier''s type. For example, `PASSPORT`, `DRIVING_LICENSE`.'
2660
+ description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
2654
2661
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
2655
2662
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/3'
2656
2663
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/4'
@@ -2661,7 +2668,7 @@ paths:
2661
2668
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/9'
2662
2669
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/10'
2663
2670
  get:
2664
- description: 'The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).'
2671
+ description: The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
2665
2672
  summary: Look up party information
2666
2673
  tags:
2667
2674
  - parties
@@ -2688,7 +2695,7 @@ paths:
2688
2695
  '503':
2689
2696
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
2690
2697
  put:
2691
- description: 'The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.'
2698
+ description: The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
2692
2699
  summary: Return party information
2693
2700
  tags:
2694
2701
  - parties
@@ -2721,9 +2728,9 @@ paths:
2721
2728
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
2722
2729
  '503':
2723
2730
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
2724
- '/parties/{Type}/{ID}/{SubId}/error':
2731
+ /parties/{Type}/{ID}/{SubId}/error:
2725
2732
  put:
2726
- description: 'If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used.'
2733
+ description: If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used.
2727
2734
  summary: Return party information error
2728
2735
  tags:
2729
2736
  - parties
@@ -2768,14 +2775,14 @@ paths:
2768
2775
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
2769
2776
  '503':
2770
2777
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
2771
- '/services/{ServiceType}':
2778
+ /services/{ServiceType}:
2772
2779
  parameters:
2773
2780
  - name: ServiceType
2774
2781
  in: path
2775
2782
  required: true
2776
2783
  schema:
2777
2784
  type: string
2778
- description: 'The type of the service identifier. For example, `THIRD_PARTY_DFSP`'
2785
+ description: The type of the service identifier. For example, `THIRD_PARTY_DFSP`
2779
2786
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
2780
2787
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/3'
2781
2788
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/4'
@@ -2873,7 +2880,7 @@ paths:
2873
2880
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/501'
2874
2881
  '503':
2875
2882
  $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/get/responses/503'
2876
- '/services/{ServiceType}/error':
2883
+ /services/{ServiceType}/error:
2877
2884
  parameters:
2878
2885
  - $ref: '#/paths/~1services~1%7BServiceType%7D/parameters/0'
2879
2886
  - $ref: '#/paths/~1parties~1%7BType%7D~1%7BID%7D/parameters/2'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v1_1/openapi3/components/headers/Content-Length.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v1_1/openapi3/components/headers/Content-Type.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/Accept.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/Content-Length.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/Content-Type.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/Date.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/FSPIOP-Destination.yaml'
@@ -0,0 +1 @@
1
+ $ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/FSPIOP-Encryption.yaml'