@mojaloop/api-snippets 17.2.5 → 17.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (190) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/audit-ci.jsonc +1 -0
  3. package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +204 -805
  4. package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +2432 -2447
  5. package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +4841 -0
  6. package/docs/index.html +1 -0
  7. package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +103 -345
  8. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +150 -492
  9. package/docs/thirdparty-openapi3-snippets.yaml +296 -886
  10. package/fspiop/v1_1/openapi3/openapi.yaml +10 -2
  11. package/fspiop/v2_0/openapi3/components/headers/Content-Length.yaml +9 -0
  12. package/fspiop/v2_0/openapi3/components/headers/Content-Type.yaml +6 -0
  13. package/fspiop/v2_0/openapi3/components/parameters/Accept.yaml +8 -0
  14. package/fspiop/v2_0/openapi3/components/parameters/Content-Length.yaml +11 -0
  15. package/fspiop/v2_0/openapi3/components/parameters/Content-Type.yaml +8 -0
  16. package/fspiop/v2_0/openapi3/components/parameters/Date.yaml +6 -0
  17. package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Destination.yaml +13 -0
  18. package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Encryption.yaml +8 -0
  19. package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +11 -0
  20. package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Signature.yaml +8 -0
  21. package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Source.yaml +10 -0
  22. package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-URI.yaml +10 -0
  23. package/fspiop/v2_0/openapi3/components/parameters/ID.yaml +6 -0
  24. package/fspiop/v2_0/openapi3/components/parameters/SourceCurrency.yaml +6 -0
  25. package/fspiop/v2_0/openapi3/components/parameters/SubId.yaml +8 -0
  26. package/fspiop/v2_0/openapi3/components/parameters/TargetCurrency.yaml +6 -0
  27. package/fspiop/v2_0/openapi3/components/parameters/Type.yaml +6 -0
  28. package/fspiop/v2_0/openapi3/components/parameters/X-Forwarded-For.yaml +15 -0
  29. package/fspiop/v2_0/openapi3/components/responses/200.yaml +1 -0
  30. package/fspiop/v2_0/openapi3/components/responses/202.yaml +1 -0
  31. package/fspiop/v2_0/openapi3/components/responses/400.yaml +10 -0
  32. package/fspiop/v2_0/openapi3/components/responses/401.yaml +10 -0
  33. package/fspiop/v2_0/openapi3/components/responses/403.yaml +10 -0
  34. package/fspiop/v2_0/openapi3/components/responses/404.yaml +10 -0
  35. package/fspiop/v2_0/openapi3/components/responses/405.yaml +10 -0
  36. package/fspiop/v2_0/openapi3/components/responses/406.yaml +10 -0
  37. package/fspiop/v2_0/openapi3/components/responses/501.yaml +10 -0
  38. package/fspiop/v2_0/openapi3/components/responses/503.yaml +10 -0
  39. package/fspiop/v2_0/openapi3/components/schemas/Amount.yaml +11 -0
  40. package/fspiop/v2_0/openapi3/components/schemas/AmountType.yaml +14 -0
  41. package/fspiop/v2_0/openapi3/components/schemas/AuthenticationInfo.yaml +11 -0
  42. package/fspiop/v2_0/openapi3/components/schemas/AuthenticationType.yaml +12 -0
  43. package/fspiop/v2_0/openapi3/components/schemas/AuthenticationValue.yaml +9 -0
  44. package/fspiop/v2_0/openapi3/components/schemas/AuthorizationResponse.yaml +12 -0
  45. package/fspiop/v2_0/openapi3/components/schemas/AuthorizationsIDPutResponse.yaml +10 -0
  46. package/fspiop/v2_0/openapi3/components/schemas/BalanceOfPayments.yaml +9 -0
  47. package/fspiop/v2_0/openapi3/components/schemas/BinaryString.yaml +7 -0
  48. package/fspiop/v2_0/openapi3/components/schemas/BinaryString32.yaml +7 -0
  49. package/fspiop/v2_0/openapi3/components/schemas/BulkQuotesIDPutResponse.yaml +18 -0
  50. package/fspiop/v2_0/openapi3/components/schemas/BulkQuotesPostRequest.yaml +25 -0
  51. package/fspiop/v2_0/openapi3/components/schemas/BulkTransferState.yaml +18 -0
  52. package/fspiop/v2_0/openapi3/components/schemas/BulkTransfersIDPutResponse.yaml +18 -0
  53. package/fspiop/v2_0/openapi3/components/schemas/BulkTransfersPostRequest.yaml +30 -0
  54. package/fspiop/v2_0/openapi3/components/schemas/Code.yaml +5 -0
  55. package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +10 -0
  56. package/fspiop/v2_0/openapi3/components/schemas/Currency.yaml +174 -0
  57. package/fspiop/v2_0/openapi3/components/schemas/CurrencyConverter.yaml +9 -0
  58. package/fspiop/v2_0/openapi3/components/schemas/Date.yaml +9 -0
  59. package/fspiop/v2_0/openapi3/components/schemas/DateOfBirth.yaml +6 -0
  60. package/fspiop/v2_0/openapi3/components/schemas/DateTime.yaml +14 -0
  61. package/fspiop/v2_0/openapi3/components/schemas/ErrorCode.yaml +11 -0
  62. package/fspiop/v2_0/openapi3/components/schemas/ErrorDescription.yaml +5 -0
  63. package/fspiop/v2_0/openapi3/components/schemas/ErrorInformation.yaml +13 -0
  64. package/fspiop/v2_0/openapi3/components/schemas/ErrorInformationObject.yaml +8 -0
  65. package/fspiop/v2_0/openapi3/components/schemas/ErrorInformationResponse.yaml +8 -0
  66. package/fspiop/v2_0/openapi3/components/schemas/Extension.yaml +11 -0
  67. package/fspiop/v2_0/openapi3/components/schemas/ExtensionKey.yaml +5 -0
  68. package/fspiop/v2_0/openapi3/components/schemas/ExtensionList.yaml +15 -0
  69. package/fspiop/v2_0/openapi3/components/schemas/ExtensionValue.yaml +5 -0
  70. package/fspiop/v2_0/openapi3/components/schemas/FirstName.yaml +9 -0
  71. package/fspiop/v2_0/openapi3/components/schemas/FspId.yaml +5 -0
  72. package/fspiop/v2_0/openapi3/components/schemas/FxCharge.yaml +19 -0
  73. package/fspiop/v2_0/openapi3/components/schemas/FxConversion.yaml +57 -0
  74. package/fspiop/v2_0/openapi3/components/schemas/FxMoney.yaml +10 -0
  75. package/fspiop/v2_0/openapi3/components/schemas/FxQuotesIDPutResponse.yaml +15 -0
  76. package/fspiop/v2_0/openapi3/components/schemas/FxQuotesPostRequest.yaml +15 -0
  77. package/fspiop/v2_0/openapi3/components/schemas/FxRate.yaml +15 -0
  78. package/fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPatchResponse.yaml +16 -0
  79. package/fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPutResponse.yaml +20 -0
  80. package/fspiop/v2_0/openapi3/components/schemas/FxTransfersPostRequest.yaml +41 -0
  81. package/fspiop/v2_0/openapi3/components/schemas/GeoCode.yaml +13 -0
  82. package/fspiop/v2_0/openapi3/components/schemas/IlpCondition.yaml +5 -0
  83. package/fspiop/v2_0/openapi3/components/schemas/IlpFulfilment.yaml +6 -0
  84. package/fspiop/v2_0/openapi3/components/schemas/IlpPacket.yaml +7 -0
  85. package/fspiop/v2_0/openapi3/components/schemas/IndividualQuote.yaml +29 -0
  86. package/fspiop/v2_0/openapi3/components/schemas/IndividualQuoteResult.yaml +26 -0
  87. package/fspiop/v2_0/openapi3/components/schemas/IndividualTransfer.yaml +19 -0
  88. package/fspiop/v2_0/openapi3/components/schemas/IndividualTransferResult.yaml +14 -0
  89. package/fspiop/v2_0/openapi3/components/schemas/Integer.yaml +7 -0
  90. package/fspiop/v2_0/openapi3/components/schemas/KYCInformation.yaml +33 -0
  91. package/fspiop/v2_0/openapi3/components/schemas/LastName.yaml +9 -0
  92. package/fspiop/v2_0/openapi3/components/schemas/Latitude.yaml +7 -0
  93. package/fspiop/v2_0/openapi3/components/schemas/Longitude.yaml +8 -0
  94. package/fspiop/v2_0/openapi3/components/schemas/MerchantClassificationCode.yaml +7 -0
  95. package/fspiop/v2_0/openapi3/components/schemas/MiddleName.yaml +9 -0
  96. package/fspiop/v2_0/openapi3/components/schemas/Money.yaml +11 -0
  97. package/fspiop/v2_0/openapi3/components/schemas/Name.yaml +17 -0
  98. package/fspiop/v2_0/openapi3/components/schemas/Note.yaml +6 -0
  99. package/fspiop/v2_0/openapi3/components/schemas/OtpValue.yaml +7 -0
  100. package/fspiop/v2_0/openapi3/components/schemas/ParticipantsIDPutResponse.yaml +17 -0
  101. package/fspiop/v2_0/openapi3/components/schemas/ParticipantsPostRequest.yaml +20 -0
  102. package/fspiop/v2_0/openapi3/components/schemas/ParticipantsTypeIDPutResponse.yaml +8 -0
  103. package/fspiop/v2_0/openapi3/components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml +15 -0
  104. package/fspiop/v2_0/openapi3/components/schemas/PartiesTypeIDPutResponse.yaml +8 -0
  105. package/fspiop/v2_0/openapi3/components/schemas/Party.yaml +21 -0
  106. package/fspiop/v2_0/openapi3/components/schemas/PartyComplexName.yaml +10 -0
  107. package/fspiop/v2_0/openapi3/components/schemas/PartyIdInfo.yaml +19 -0
  108. package/fspiop/v2_0/openapi3/components/schemas/PartyIdType.yaml +54 -0
  109. package/fspiop/v2_0/openapi3/components/schemas/PartyIdentifier.yaml +6 -0
  110. package/fspiop/v2_0/openapi3/components/schemas/PartyName.yaml +5 -0
  111. package/fspiop/v2_0/openapi3/components/schemas/PartyPersonalInfo.yaml +10 -0
  112. package/fspiop/v2_0/openapi3/components/schemas/PartyResult.yaml +10 -0
  113. package/fspiop/v2_0/openapi3/components/schemas/PartySubIdOrType.yaml +7 -0
  114. package/fspiop/v2_0/openapi3/components/schemas/PersonalIdentifierType.yaml +51 -0
  115. package/fspiop/v2_0/openapi3/components/schemas/QRCODE.yaml +5 -0
  116. package/fspiop/v2_0/openapi3/components/schemas/QuotesIDPutResponse.yaml +27 -0
  117. package/fspiop/v2_0/openapi3/components/schemas/QuotesPostRequest.yaml +53 -0
  118. package/fspiop/v2_0/openapi3/components/schemas/Refund.yaml +10 -0
  119. package/fspiop/v2_0/openapi3/components/schemas/RefundReason.yaml +6 -0
  120. package/fspiop/v2_0/openapi3/components/schemas/ServicesFXPPutResponse.yaml +13 -0
  121. package/fspiop/v2_0/openapi3/components/schemas/ServicesFXPSourceCurrencyTargetCurrencyPutResponse.yaml +13 -0
  122. package/fspiop/v2_0/openapi3/components/schemas/TokenCode.yaml +6 -0
  123. package/fspiop/v2_0/openapi3/components/schemas/Transaction.yaml +50 -0
  124. package/fspiop/v2_0/openapi3/components/schemas/TransactionInitiator.yaml +16 -0
  125. package/fspiop/v2_0/openapi3/components/schemas/TransactionInitiatorType.yaml +14 -0
  126. package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestState.yaml +14 -0
  127. package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestsIDPutResponse.yaml +12 -0
  128. package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestsPostRequest.yaml +30 -0
  129. package/fspiop/v2_0/openapi3/components/schemas/TransactionScenario.yaml +32 -0
  130. package/fspiop/v2_0/openapi3/components/schemas/TransactionState.yaml +14 -0
  131. package/fspiop/v2_0/openapi3/components/schemas/TransactionSubScenario.yaml +5 -0
  132. package/fspiop/v2_0/openapi3/components/schemas/TransactionType.yaml +20 -0
  133. package/fspiop/v2_0/openapi3/components/schemas/TransactionsIDPutResponse.yaml +14 -0
  134. package/fspiop/v2_0/openapi3/components/schemas/TransferState.yaml +19 -0
  135. package/fspiop/v2_0/openapi3/components/schemas/TransfersIDPatchResponse.yaml +13 -0
  136. package/fspiop/v2_0/openapi3/components/schemas/TransfersIDPutResponse.yaml +14 -0
  137. package/fspiop/v2_0/openapi3/components/schemas/TransfersPostRequest.yaml +28 -0
  138. package/fspiop/v2_0/openapi3/components/schemas/U2FPIN.yaml +8 -0
  139. package/fspiop/v2_0/openapi3/components/schemas/U2FPinValue.yaml +19 -0
  140. package/fspiop/v2_0/openapi3/components/schemas/UndefinedEnum.yaml +6 -0
  141. package/fspiop/v2_0/openapi3/openapi.yaml +136 -0
  142. package/fspiop/v2_0/openapi3/paths/authorizations_ID.yaml +110 -0
  143. package/fspiop/v2_0/openapi3/paths/authorizations_ID_error.yaml +48 -0
  144. package/fspiop/v2_0/openapi3/paths/bulkQuotes.yaml +46 -0
  145. package/fspiop/v2_0/openapi3/paths/bulkQuotes_ID.yaml +79 -0
  146. package/fspiop/v2_0/openapi3/paths/bulkQuotes_ID_error.yaml +49 -0
  147. package/fspiop/v2_0/openapi3/paths/bulkTransfers.yaml +46 -0
  148. package/fspiop/v2_0/openapi3/paths/bulkTransfers_ID.yaml +81 -0
  149. package/fspiop/v2_0/openapi3/paths/bulkTransfers_ID_error.yaml +49 -0
  150. package/fspiop/v2_0/openapi3/paths/fxQuotes.yaml +45 -0
  151. package/fspiop/v2_0/openapi3/paths/fxQuotes_ID.yaml +79 -0
  152. package/fspiop/v2_0/openapi3/paths/fxQuotes_ID_error.yaml +49 -0
  153. package/fspiop/v2_0/openapi3/paths/fxTransfers.yaml +45 -0
  154. package/fspiop/v2_0/openapi3/paths/fxTransfers_ID.yaml +118 -0
  155. package/fspiop/v2_0/openapi3/paths/fxTransfers_ID_error.yaml +49 -0
  156. package/fspiop/v2_0/openapi3/paths/participants.yaml +49 -0
  157. package/fspiop/v2_0/openapi3/paths/participants_ID.yaml +46 -0
  158. package/fspiop/v2_0/openapi3/paths/participants_ID_error.yaml +48 -0
  159. package/fspiop/v2_0/openapi3/paths/participants_Type_ID.yaml +167 -0
  160. package/fspiop/v2_0/openapi3/paths/participants_Type_ID_SubId.yaml +168 -0
  161. package/fspiop/v2_0/openapi3/paths/participants_Type_ID_SubId_error.yaml +50 -0
  162. package/fspiop/v2_0/openapi3/paths/participants_Type_ID_error.yaml +49 -0
  163. package/fspiop/v2_0/openapi3/paths/parties_Type_ID.yaml +81 -0
  164. package/fspiop/v2_0/openapi3/paths/parties_Type_ID_SubId.yaml +82 -0
  165. package/fspiop/v2_0/openapi3/paths/parties_Type_ID_SubId_error.yaml +50 -0
  166. package/fspiop/v2_0/openapi3/paths/parties_Type_ID_error.yaml +49 -0
  167. package/fspiop/v2_0/openapi3/paths/quotes.yaml +46 -0
  168. package/fspiop/v2_0/openapi3/paths/quotes_ID.yaml +79 -0
  169. package/fspiop/v2_0/openapi3/paths/quotes_ID_error.yaml +49 -0
  170. package/fspiop/v2_0/openapi3/paths/services_FXP.yaml +73 -0
  171. package/fspiop/v2_0/openapi3/paths/services_FXP_SourceCurrency_TargetCurrency.yaml +77 -0
  172. package/fspiop/v2_0/openapi3/paths/transactionRequests.yaml +47 -0
  173. package/fspiop/v2_0/openapi3/paths/transactionRequests_ID.yaml +81 -0
  174. package/fspiop/v2_0/openapi3/paths/transactionRequests_ID_error.yaml +50 -0
  175. package/fspiop/v2_0/openapi3/paths/transactions_ID.yaml +80 -0
  176. package/fspiop/v2_0/openapi3/paths/transactions_ID_error.yaml +48 -0
  177. package/fspiop/v2_0/openapi3/paths/transfers.yaml +46 -0
  178. package/fspiop/v2_0/openapi3/paths/transfers_ID.yaml +119 -0
  179. package/fspiop/v2_0/openapi3/paths/transfers_ID_error.yaml +49 -0
  180. package/lib/fspiop/v1_1/openapi.d.ts +524 -542
  181. package/lib/fspiop/v2_0/openapi.d.ts +3964 -0
  182. package/lib/fspiop/v2_0/openapi.js +7 -0
  183. package/lib/fspiop/v2_0/openapi.js.map +1 -0
  184. package/lib/scripts/json-schema-generator.js +4 -5
  185. package/lib/scripts/json-schema-generator.js.map +1 -1
  186. package/lib/scripts/openapi-refactor.d.ts +29 -0
  187. package/lib/scripts/openapi-refactor.js +70 -0
  188. package/lib/scripts/openapi-refactor.js.map +1 -0
  189. package/package.json +29 -21
  190. package/tsconfig.build.json +1 -1
@@ -0,0 +1,49 @@
1
+ put:
2
+ description: >-
3
+ If the switch or FXP is unable to find or create a FX transfer, or another processing
4
+ error occurs, the error callback `PUT /fxTransfers/{ID}/error` is used. The
5
+ `{ID}` in the URI should contain the `commitRequestId` that was used for the
6
+ creation of the FX transfer, or the `{ID}` that was used in the `GET
7
+ /fxTransfers/{ID}`.
8
+ summary: Return FX transfer information error
9
+ tags:
10
+ - fxTransfers
11
+ operationId: FxTransfersByIDAndErrorPut
12
+ parameters:
13
+ - $ref: ../components/parameters/ID.yaml
14
+ - $ref: ../components/parameters/Content-Length.yaml
15
+ - $ref: ../components/parameters/Content-Type.yaml
16
+ - $ref: ../components/parameters/Date.yaml
17
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
18
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
19
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
20
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
21
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
22
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
23
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
24
+ requestBody:
25
+ description: Details of the error returned.
26
+ required: true
27
+ content:
28
+ application/json:
29
+ schema:
30
+ $ref: ../components/schemas/ErrorInformationObject.yaml
31
+ responses:
32
+ '200':
33
+ $ref: ../components/responses/200.yaml
34
+ '400':
35
+ $ref: ../components/responses/400.yaml
36
+ '401':
37
+ $ref: ../components/responses/401.yaml
38
+ '403':
39
+ $ref: ../components/responses/403.yaml
40
+ '404':
41
+ $ref: ../components/responses/404.yaml
42
+ '405':
43
+ $ref: ../components/responses/405.yaml
44
+ '406':
45
+ $ref: ../components/responses/406.yaml
46
+ '501':
47
+ $ref: ../components/responses/501.yaml
48
+ '503':
49
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,49 @@
1
+ post:
2
+ description: >-
3
+ The HTTP request `POST /participants` is used to create information in the
4
+ server regarding the provided list of identities. This request should be
5
+ used for bulk creation of FSP information for more than one Party. The
6
+ optional currency parameter should indicate that each provided Party
7
+ supports the currency.
8
+ summary: Create bulk participant information
9
+ tags:
10
+ - participants
11
+ operationId: Participants1
12
+ parameters:
13
+ - $ref: ../components/parameters/Accept.yaml
14
+ - $ref: ../components/parameters/Content-Length.yaml
15
+ - $ref: ../components/parameters/Content-Type.yaml
16
+ - $ref: ../components/parameters/Date.yaml
17
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
18
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
19
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
20
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
21
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
22
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
23
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
24
+ requestBody:
25
+ description: Participant information to be created.
26
+ required: true
27
+ content:
28
+ application/json:
29
+ schema:
30
+ $ref: ../components/schemas/ParticipantsPostRequest.yaml
31
+ responses:
32
+ '202':
33
+ $ref: ../components/responses/202.yaml
34
+ '400':
35
+ $ref: ../components/responses/400.yaml
36
+ '401':
37
+ $ref: ../components/responses/401.yaml
38
+ '403':
39
+ $ref: ../components/responses/403.yaml
40
+ '404':
41
+ $ref: ../components/responses/404.yaml
42
+ '405':
43
+ $ref: ../components/responses/405.yaml
44
+ '406':
45
+ $ref: ../components/responses/406.yaml
46
+ '501':
47
+ $ref: ../components/responses/501.yaml
48
+ '503':
49
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,46 @@
1
+ put:
2
+ description: >-
3
+ The callback `PUT /participants/{ID}` is used to inform the client of the
4
+ result of the creation of the provided list of identities.
5
+ summary: Return bulk participant information
6
+ tags:
7
+ - participants
8
+ operationId: putParticipantsByID
9
+ parameters:
10
+ - $ref: ../components/parameters/ID.yaml
11
+ - $ref: ../components/parameters/Content-Length.yaml
12
+ - $ref: ../components/parameters/Content-Type.yaml
13
+ - $ref: ../components/parameters/Date.yaml
14
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
15
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
16
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
17
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
18
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
19
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
20
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
21
+ requestBody:
22
+ description: Participant information returned.
23
+ required: true
24
+ content:
25
+ application/json:
26
+ schema:
27
+ $ref: ../components/schemas/ParticipantsIDPutResponse.yaml
28
+ responses:
29
+ '200':
30
+ $ref: ../components/responses/200.yaml
31
+ '400':
32
+ $ref: ../components/responses/400.yaml
33
+ '401':
34
+ $ref: ../components/responses/401.yaml
35
+ '403':
36
+ $ref: ../components/responses/403.yaml
37
+ '404':
38
+ $ref: ../components/responses/404.yaml
39
+ '405':
40
+ $ref: ../components/responses/405.yaml
41
+ '406':
42
+ $ref: ../components/responses/406.yaml
43
+ '501':
44
+ $ref: ../components/responses/501.yaml
45
+ '503':
46
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,48 @@
1
+ put:
2
+ description: >-
3
+ If there is an error during FSP information creation in the server, the
4
+ error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI
5
+ should contain the requestId that was used for the creation of the
6
+ participant information.
7
+ summary: Return bulk participant information error
8
+ tags:
9
+ - participants
10
+ operationId: ParticipantsByIDAndError
11
+ parameters:
12
+ - $ref: ../components/parameters/ID.yaml
13
+ - $ref: ../components/parameters/Content-Length.yaml
14
+ - $ref: ../components/parameters/Content-Type.yaml
15
+ - $ref: ../components/parameters/Date.yaml
16
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
17
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
18
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
19
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
20
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
21
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
22
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
23
+ requestBody:
24
+ description: Details of the error returned.
25
+ required: true
26
+ content:
27
+ application/json:
28
+ schema:
29
+ $ref: ../components/schemas/ErrorInformationObject.yaml
30
+ responses:
31
+ '200':
32
+ $ref: ../components/responses/200.yaml
33
+ '400':
34
+ $ref: ../components/responses/400.yaml
35
+ '401':
36
+ $ref: ../components/responses/401.yaml
37
+ '403':
38
+ $ref: ../components/responses/403.yaml
39
+ '404':
40
+ $ref: ../components/responses/404.yaml
41
+ '405':
42
+ $ref: ../components/responses/405.yaml
43
+ '406':
44
+ $ref: ../components/responses/406.yaml
45
+ '501':
46
+ $ref: ../components/responses/501.yaml
47
+ '503':
48
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,167 @@
1
+ parameters:
2
+ - $ref: ../components/parameters/Type.yaml
3
+ - $ref: ../components/parameters/ID.yaml
4
+ - $ref: ../components/parameters/Content-Type.yaml
5
+ - $ref: ../components/parameters/Date.yaml
6
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
7
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
8
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
9
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
10
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
11
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
12
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
13
+ post:
14
+ description: >-
15
+ The HTTP request `POST /participants/{Type}/{ID}` (or `POST
16
+ /participants/{Type}/{ID}/{SubId}`) is used to create information in the
17
+ server regarding the provided identity, defined by `{Type}`, `{ID}`, and
18
+ optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or
19
+ `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList
20
+ element has been added to this reqeust in version v1.1
21
+ summary: Create participant information
22
+ tags:
23
+ - participants
24
+ operationId: ParticipantsByIDAndType
25
+ parameters:
26
+ - $ref: ../components/parameters/Accept.yaml
27
+ - $ref: ../components/parameters/Content-Length.yaml
28
+ requestBody:
29
+ description: Participant information to be created.
30
+ required: true
31
+ content:
32
+ application/json:
33
+ schema:
34
+ $ref: ../components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml
35
+ responses:
36
+ '202':
37
+ $ref: ../components/responses/202.yaml
38
+ '400':
39
+ $ref: ../components/responses/400.yaml
40
+ '401':
41
+ $ref: ../components/responses/401.yaml
42
+ '403':
43
+ $ref: ../components/responses/403.yaml
44
+ '404':
45
+ $ref: ../components/responses/404.yaml
46
+ '405':
47
+ $ref: ../components/responses/405.yaml
48
+ '406':
49
+ $ref: ../components/responses/406.yaml
50
+ '501':
51
+ $ref: ../components/responses/501.yaml
52
+ '503':
53
+ $ref: ../components/responses/503.yaml
54
+ get:
55
+ description: >-
56
+ The HTTP request `GET /participants/{Type}/{ID}` (or `GET
57
+ /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the
58
+ requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is
59
+ located (for example, `GET /participants/MSISDN/123456789`, or `GET
60
+ /participants/BUSINESS/shoecompany/employee1`). This HTTP request should
61
+ support a query string for filtering of currency. To use filtering of
62
+ currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ`
63
+ should be used, where `XYZ` is the requested currency.
64
+ summary: Look up participant information
65
+ tags:
66
+ - participants
67
+ operationId: ParticipantsByTypeAndID
68
+ parameters:
69
+ - $ref: ../components/parameters/Accept.yaml
70
+ responses:
71
+ '202':
72
+ $ref: ../components/responses/202.yaml
73
+ '400':
74
+ $ref: ../components/responses/400.yaml
75
+ '401':
76
+ $ref: ../components/responses/401.yaml
77
+ '403':
78
+ $ref: ../components/responses/403.yaml
79
+ '404':
80
+ $ref: ../components/responses/404.yaml
81
+ '405':
82
+ $ref: ../components/responses/405.yaml
83
+ '406':
84
+ $ref: ../components/responses/406.yaml
85
+ '501':
86
+ $ref: ../components/responses/501.yaml
87
+ '503':
88
+ $ref: ../components/responses/503.yaml
89
+ put:
90
+ description: >-
91
+ The callback `PUT /participants/{Type}/{ID}` (or `PUT
92
+ /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a
93
+ successful result of the lookup, creation, or deletion of the FSP
94
+ information related to the Party. If the FSP information is deleted, the
95
+ fspId element should be empty; otherwise the element should include the FSP
96
+ information for the Party.
97
+ summary: Return participant information
98
+ tags:
99
+ - participants
100
+ operationId: ParticipantsByTypeAndID3
101
+ parameters:
102
+ - $ref: ../components/parameters/Content-Length.yaml
103
+ requestBody:
104
+ description: Participant information returned.
105
+ required: true
106
+ content:
107
+ application/json:
108
+ schema:
109
+ $ref: ../components/schemas/ParticipantsTypeIDPutResponse.yaml
110
+ responses:
111
+ '200':
112
+ $ref: ../components/responses/200.yaml
113
+ '400':
114
+ $ref: ../components/responses/400.yaml
115
+ '401':
116
+ $ref: ../components/responses/401.yaml
117
+ '403':
118
+ $ref: ../components/responses/403.yaml
119
+ '404':
120
+ $ref: ../components/responses/404.yaml
121
+ '405':
122
+ $ref: ../components/responses/405.yaml
123
+ '406':
124
+ $ref: ../components/responses/406.yaml
125
+ '501':
126
+ $ref: ../components/responses/501.yaml
127
+ '503':
128
+ $ref: ../components/responses/503.yaml
129
+ delete:
130
+ description: >-
131
+ The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE
132
+ /participants/{Type}/{ID}/{SubId}`) is used to delete information in the
133
+ server regarding the provided identity, defined by `{Type}` and `{ID}`) (for
134
+ example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`.
135
+ This HTTP request should support a query string to delete FSP information
136
+ regarding a specific currency only. To delete a specific currency only, the
137
+ HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used,
138
+ where `XYZ` is the requested currency.
139
+
140
+
141
+ **Note:** The Account Lookup System should verify that it is the Party’s
142
+ current FSP that is deleting the FSP information.
143
+ summary: Delete participant information
144
+ tags:
145
+ - participants
146
+ operationId: ParticipantsByTypeAndID2
147
+ parameters:
148
+ - $ref: ../components/parameters/Accept.yaml
149
+ responses:
150
+ '202':
151
+ $ref: ../components/responses/202.yaml
152
+ '400':
153
+ $ref: ../components/responses/400.yaml
154
+ '401':
155
+ $ref: ../components/responses/401.yaml
156
+ '403':
157
+ $ref: ../components/responses/403.yaml
158
+ '404':
159
+ $ref: ../components/responses/404.yaml
160
+ '405':
161
+ $ref: ../components/responses/405.yaml
162
+ '406':
163
+ $ref: ../components/responses/406.yaml
164
+ '501':
165
+ $ref: ../components/responses/501.yaml
166
+ '503':
167
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,168 @@
1
+ parameters:
2
+ - $ref: ../components/parameters/Type.yaml
3
+ - $ref: ../components/parameters/ID.yaml
4
+ - $ref: ../components/parameters/SubId.yaml
5
+ - $ref: ../components/parameters/Content-Type.yaml
6
+ - $ref: ../components/parameters/Date.yaml
7
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
8
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
9
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
10
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
11
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
12
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
13
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
14
+ post:
15
+ description: >-
16
+ The HTTP request `POST /participants/{Type}/{ID}` (or `POST
17
+ /participants/{Type}/{ID}/{SubId}`) is used to create information in the
18
+ server regarding the provided identity, defined by `{Type}`, `{ID}`, and
19
+ optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or
20
+ `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList
21
+ element has been added to this reqeust in version v1.1
22
+ summary: Create participant information
23
+ tags:
24
+ - participants
25
+ operationId: ParticipantsSubIdByTypeAndIDPost
26
+ parameters:
27
+ - $ref: ../components/parameters/Accept.yaml
28
+ - $ref: ../components/parameters/Content-Length.yaml
29
+ requestBody:
30
+ description: Participant information to be created.
31
+ required: true
32
+ content:
33
+ application/json:
34
+ schema:
35
+ $ref: ../components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml
36
+ responses:
37
+ '202':
38
+ $ref: ../components/responses/202.yaml
39
+ '400':
40
+ $ref: ../components/responses/400.yaml
41
+ '401':
42
+ $ref: ../components/responses/401.yaml
43
+ '403':
44
+ $ref: ../components/responses/403.yaml
45
+ '404':
46
+ $ref: ../components/responses/404.yaml
47
+ '405':
48
+ $ref: ../components/responses/405.yaml
49
+ '406':
50
+ $ref: ../components/responses/406.yaml
51
+ '501':
52
+ $ref: ../components/responses/501.yaml
53
+ '503':
54
+ $ref: ../components/responses/503.yaml
55
+ get:
56
+ description: >-
57
+ The HTTP request `GET /participants/{Type}/{ID}` (or `GET
58
+ /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the
59
+ requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is
60
+ located (for example, `GET /participants/MSISDN/123456789`, or `GET
61
+ /participants/BUSINESS/shoecompany/employee1`). This HTTP request should
62
+ support a query string for filtering of currency. To use filtering of
63
+ currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ`
64
+ should be used, where `XYZ` is the requested currency.
65
+ summary: Look up participant information
66
+ tags:
67
+ - participants
68
+ operationId: ParticipantsSubIdByTypeAndID
69
+ parameters:
70
+ - $ref: ../components/parameters/Accept.yaml
71
+ responses:
72
+ '202':
73
+ $ref: ../components/responses/202.yaml
74
+ '400':
75
+ $ref: ../components/responses/400.yaml
76
+ '401':
77
+ $ref: ../components/responses/401.yaml
78
+ '403':
79
+ $ref: ../components/responses/403.yaml
80
+ '404':
81
+ $ref: ../components/responses/404.yaml
82
+ '405':
83
+ $ref: ../components/responses/405.yaml
84
+ '406':
85
+ $ref: ../components/responses/406.yaml
86
+ '501':
87
+ $ref: ../components/responses/501.yaml
88
+ '503':
89
+ $ref: ../components/responses/503.yaml
90
+ put:
91
+ description: >-
92
+ The callback `PUT /participants/{Type}/{ID}` (or `PUT
93
+ /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a
94
+ successful result of the lookup, creation, or deletion of the FSP
95
+ information related to the Party. If the FSP information is deleted, the
96
+ fspId element should be empty; otherwise the element should include the FSP
97
+ information for the Party.
98
+ summary: Return participant information
99
+ tags:
100
+ - participants
101
+ operationId: ParticipantsSubIdByTypeAndID3
102
+ parameters:
103
+ - $ref: ../components/parameters/Content-Length.yaml
104
+ requestBody:
105
+ description: Participant information returned.
106
+ required: true
107
+ content:
108
+ application/json:
109
+ schema:
110
+ $ref: ../components/schemas/ParticipantsTypeIDPutResponse.yaml
111
+ responses:
112
+ '200':
113
+ $ref: ../components/responses/200.yaml
114
+ '400':
115
+ $ref: ../components/responses/400.yaml
116
+ '401':
117
+ $ref: ../components/responses/401.yaml
118
+ '403':
119
+ $ref: ../components/responses/403.yaml
120
+ '404':
121
+ $ref: ../components/responses/404.yaml
122
+ '405':
123
+ $ref: ../components/responses/405.yaml
124
+ '406':
125
+ $ref: ../components/responses/406.yaml
126
+ '501':
127
+ $ref: ../components/responses/501.yaml
128
+ '503':
129
+ $ref: ../components/responses/503.yaml
130
+ delete:
131
+ description: >-
132
+ The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE
133
+ /participants/{Type}/{ID}/{SubId}`) is used to delete information in the
134
+ server regarding the provided identity, defined by `{Type}` and `{ID}`) (for
135
+ example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`.
136
+ This HTTP request should support a query string to delete FSP information
137
+ regarding a specific currency only. To delete a specific currency only, the
138
+ HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used,
139
+ where `XYZ` is the requested currency.
140
+
141
+
142
+ **Note:** The Account Lookup System should verify that it is the Party’s
143
+ current FSP that is deleting the FSP information.
144
+ summary: Delete participant information
145
+ tags:
146
+ - participants
147
+ operationId: ParticipantsSubIdByTypeAndID2
148
+ parameters:
149
+ - $ref: ../components/parameters/Accept.yaml
150
+ responses:
151
+ '202':
152
+ $ref: ../components/responses/202.yaml
153
+ '400':
154
+ $ref: ../components/responses/400.yaml
155
+ '401':
156
+ $ref: ../components/responses/401.yaml
157
+ '403':
158
+ $ref: ../components/responses/403.yaml
159
+ '404':
160
+ $ref: ../components/responses/404.yaml
161
+ '405':
162
+ $ref: ../components/responses/405.yaml
163
+ '406':
164
+ $ref: ../components/responses/406.yaml
165
+ '501':
166
+ $ref: ../components/responses/501.yaml
167
+ '503':
168
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,50 @@
1
+ put:
2
+ description: >-
3
+ If the server is unable to find, create or delete the associated FSP of the
4
+ provided identity, or another processing error occurred, the error callback
5
+ `PUT /participants/{Type}/{ID}/error` (or `PUT
6
+ /participants/{Type}/{ID}/{SubId}/error`) is used.
7
+ summary: Return participant information error
8
+ tags:
9
+ - participants
10
+ operationId: ParticipantsSubIdErrorByTypeAndID
11
+ parameters:
12
+ - $ref: ../components/parameters/Type.yaml
13
+ - $ref: ../components/parameters/ID.yaml
14
+ - $ref: ../components/parameters/SubId.yaml
15
+ - $ref: ../components/parameters/Content-Length.yaml
16
+ - $ref: ../components/parameters/Content-Type.yaml
17
+ - $ref: ../components/parameters/Date.yaml
18
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
19
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
20
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
21
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
22
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
23
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
24
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
25
+ requestBody:
26
+ description: Details of the error returned.
27
+ required: true
28
+ content:
29
+ application/json:
30
+ schema:
31
+ $ref: ../components/schemas/ErrorInformationObject.yaml
32
+ responses:
33
+ '200':
34
+ $ref: ../components/responses/200.yaml
35
+ '400':
36
+ $ref: ../components/responses/400.yaml
37
+ '401':
38
+ $ref: ../components/responses/401.yaml
39
+ '403':
40
+ $ref: ../components/responses/403.yaml
41
+ '404':
42
+ $ref: ../components/responses/404.yaml
43
+ '405':
44
+ $ref: ../components/responses/405.yaml
45
+ '406':
46
+ $ref: ../components/responses/406.yaml
47
+ '501':
48
+ $ref: ../components/responses/501.yaml
49
+ '503':
50
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,49 @@
1
+ put:
2
+ description: >-
3
+ If the server is unable to find, create or delete the associated FSP of the
4
+ provided identity, or another processing error occurred, the error callback
5
+ `PUT /participants/{Type}/{ID}/error` (or `PUT
6
+ /participants/{Type}/{ID}/{SubId}/error`) is used.
7
+ summary: Return participant information error
8
+ tags:
9
+ - participants
10
+ operationId: ParticipantsErrorByTypeAndID
11
+ parameters:
12
+ - $ref: ../components/parameters/Type.yaml
13
+ - $ref: ../components/parameters/ID.yaml
14
+ - $ref: ../components/parameters/Content-Length.yaml
15
+ - $ref: ../components/parameters/Content-Type.yaml
16
+ - $ref: ../components/parameters/Date.yaml
17
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
18
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
19
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
20
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
21
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
22
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
23
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
24
+ requestBody:
25
+ description: Details of the error returned.
26
+ required: true
27
+ content:
28
+ application/json:
29
+ schema:
30
+ $ref: ../components/schemas/ErrorInformationObject.yaml
31
+ responses:
32
+ '200':
33
+ $ref: ../components/responses/200.yaml
34
+ '400':
35
+ $ref: ../components/responses/400.yaml
36
+ '401':
37
+ $ref: ../components/responses/401.yaml
38
+ '403':
39
+ $ref: ../components/responses/403.yaml
40
+ '404':
41
+ $ref: ../components/responses/404.yaml
42
+ '405':
43
+ $ref: ../components/responses/405.yaml
44
+ '406':
45
+ $ref: ../components/responses/406.yaml
46
+ '501':
47
+ $ref: ../components/responses/501.yaml
48
+ '503':
49
+ $ref: ../components/responses/503.yaml