@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,81 @@
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
+ get:
14
+ description: >-
15
+ The HTTP request `GET /parties/{Type}/{ID}` (or `GET
16
+ /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the
17
+ requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for
18
+ example, `GET /parties/MSISDN/123456789`, or `GET
19
+ /parties/BUSINESS/shoecompany/employee1`).
20
+ summary: Look up party information
21
+ tags:
22
+ - parties
23
+ operationId: PartiesByTypeAndID
24
+ parameters:
25
+ - $ref: ../components/parameters/Accept.yaml
26
+ responses:
27
+ '202':
28
+ $ref: ../components/responses/202.yaml
29
+ '400':
30
+ $ref: ../components/responses/400.yaml
31
+ '401':
32
+ $ref: ../components/responses/401.yaml
33
+ '403':
34
+ $ref: ../components/responses/403.yaml
35
+ '404':
36
+ $ref: ../components/responses/404.yaml
37
+ '405':
38
+ $ref: ../components/responses/405.yaml
39
+ '406':
40
+ $ref: ../components/responses/406.yaml
41
+ '501':
42
+ $ref: ../components/responses/501.yaml
43
+ '503':
44
+ $ref: ../components/responses/503.yaml
45
+ put:
46
+ description: >-
47
+ The callback `PUT /parties/{Type}/{ID}` (or `PUT
48
+ /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful
49
+ result of the Party information lookup.
50
+ summary: Return party information
51
+ tags:
52
+ - parties
53
+ operationId: PartiesByTypeAndID2
54
+ parameters:
55
+ - $ref: ../components/parameters/Content-Length.yaml
56
+ requestBody:
57
+ description: Party information returned.
58
+ required: true
59
+ content:
60
+ application/json:
61
+ schema:
62
+ $ref: ../components/schemas/PartiesTypeIDPutResponse.yaml
63
+ responses:
64
+ '200':
65
+ $ref: ../components/responses/200.yaml
66
+ '400':
67
+ $ref: ../components/responses/400.yaml
68
+ '401':
69
+ $ref: ../components/responses/401.yaml
70
+ '403':
71
+ $ref: ../components/responses/403.yaml
72
+ '404':
73
+ $ref: ../components/responses/404.yaml
74
+ '405':
75
+ $ref: ../components/responses/405.yaml
76
+ '406':
77
+ $ref: ../components/responses/406.yaml
78
+ '501':
79
+ $ref: ../components/responses/501.yaml
80
+ '503':
81
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,82 @@
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
+ get:
15
+ description: >-
16
+ The HTTP request `GET /parties/{Type}/{ID}` (or `GET
17
+ /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the
18
+ requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for
19
+ example, `GET /parties/MSISDN/123456789`, or `GET
20
+ /parties/BUSINESS/shoecompany/employee1`).
21
+ summary: Look up party information
22
+ tags:
23
+ - parties
24
+ operationId: PartiesSubIdByTypeAndID
25
+ parameters:
26
+ - $ref: ../components/parameters/Accept.yaml
27
+ responses:
28
+ '202':
29
+ $ref: ../components/responses/202.yaml
30
+ '400':
31
+ $ref: ../components/responses/400.yaml
32
+ '401':
33
+ $ref: ../components/responses/401.yaml
34
+ '403':
35
+ $ref: ../components/responses/403.yaml
36
+ '404':
37
+ $ref: ../components/responses/404.yaml
38
+ '405':
39
+ $ref: ../components/responses/405.yaml
40
+ '406':
41
+ $ref: ../components/responses/406.yaml
42
+ '501':
43
+ $ref: ../components/responses/501.yaml
44
+ '503':
45
+ $ref: ../components/responses/503.yaml
46
+ put:
47
+ description: >-
48
+ The callback `PUT /parties/{Type}/{ID}` (or `PUT
49
+ /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful
50
+ result of the Party information lookup.
51
+ summary: Return party information
52
+ tags:
53
+ - parties
54
+ operationId: PartiesSubIdByTypeAndIDPut
55
+ parameters:
56
+ - $ref: ../components/parameters/Content-Length.yaml
57
+ requestBody:
58
+ description: Party information returned.
59
+ required: true
60
+ content:
61
+ application/json:
62
+ schema:
63
+ $ref: ../components/schemas/PartiesTypeIDPutResponse.yaml
64
+ responses:
65
+ '200':
66
+ $ref: ../components/responses/200.yaml
67
+ '400':
68
+ $ref: ../components/responses/400.yaml
69
+ '401':
70
+ $ref: ../components/responses/401.yaml
71
+ '403':
72
+ $ref: ../components/responses/403.yaml
73
+ '404':
74
+ $ref: ../components/responses/404.yaml
75
+ '405':
76
+ $ref: ../components/responses/405.yaml
77
+ '406':
78
+ $ref: ../components/responses/406.yaml
79
+ '501':
80
+ $ref: ../components/responses/501.yaml
81
+ '503':
82
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,50 @@
1
+ put:
2
+ description: >-
3
+ If the server is unable to find Party information of the provided identity,
4
+ or another processing error occurred, the error callback `PUT
5
+ /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is
6
+ used.
7
+ summary: Return party information error
8
+ tags:
9
+ - parties
10
+ operationId: PartiesSubIdErrorByTypeAndID
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 Party information of the provided identity,
4
+ or another processing error occurred, the error callback `PUT
5
+ /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is
6
+ used.
7
+ summary: Return party information error
8
+ tags:
9
+ - parties
10
+ operationId: PartiesErrorByTypeAndID
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
@@ -0,0 +1,46 @@
1
+ post:
2
+ description: >-
3
+ The HTTP request `POST /quotes` is used to request the creation of a quote
4
+ for the provided financial transaction in the server.
5
+ summary: Calculate quote
6
+ tags:
7
+ - quotes
8
+ operationId: Quotes
9
+ parameters:
10
+ - $ref: ../components/parameters/Accept.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: Details of the quote to be created.
23
+ required: true
24
+ content:
25
+ application/json:
26
+ schema:
27
+ $ref: ../components/schemas/QuotesPostRequest.yaml
28
+ responses:
29
+ '202':
30
+ $ref: ../components/responses/202.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,79 @@
1
+ parameters:
2
+ - $ref: ../components/parameters/ID.yaml
3
+ - $ref: ../components/parameters/Content-Type.yaml
4
+ - $ref: ../components/parameters/Date.yaml
5
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
6
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
7
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
8
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
9
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
10
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
11
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
12
+ get:
13
+ description: >-
14
+ The HTTP request `GET /quotes/{ID}` is used to get information regarding a
15
+ quote created or requested earlier. The `{ID}` in the URI should contain the
16
+ `quoteId` that was used for the creation of the quote.
17
+ summary: Retrieve quote information
18
+ tags:
19
+ - quotes
20
+ operationId: QuotesByID
21
+ parameters:
22
+ - $ref: ../components/parameters/Accept.yaml
23
+ responses:
24
+ '202':
25
+ $ref: ../components/responses/202.yaml
26
+ '400':
27
+ $ref: ../components/responses/400.yaml
28
+ '401':
29
+ $ref: ../components/responses/401.yaml
30
+ '403':
31
+ $ref: ../components/responses/403.yaml
32
+ '404':
33
+ $ref: ../components/responses/404.yaml
34
+ '405':
35
+ $ref: ../components/responses/405.yaml
36
+ '406':
37
+ $ref: ../components/responses/406.yaml
38
+ '501':
39
+ $ref: ../components/responses/501.yaml
40
+ '503':
41
+ $ref: ../components/responses/503.yaml
42
+ put:
43
+ description: >-
44
+ The callback `PUT /quotes/{ID}` is used to inform the client of a requested
45
+ or created quote. The `{ID}` in the URI should contain the `quoteId` that
46
+ was used for the creation of the quote, or the `{ID}` that was used in the
47
+ `GET /quotes/{ID}` request.
48
+ summary: Return quote information
49
+ tags:
50
+ - quotes
51
+ operationId: QuotesByID1
52
+ parameters:
53
+ - $ref: ../components/parameters/Content-Length.yaml
54
+ requestBody:
55
+ description: Quote information returned.
56
+ required: true
57
+ content:
58
+ application/json:
59
+ schema:
60
+ $ref: ../components/schemas/QuotesIDPutResponse.yaml
61
+ responses:
62
+ '200':
63
+ $ref: ../components/responses/200.yaml
64
+ '400':
65
+ $ref: ../components/responses/400.yaml
66
+ '401':
67
+ $ref: ../components/responses/401.yaml
68
+ '403':
69
+ $ref: ../components/responses/403.yaml
70
+ '404':
71
+ $ref: ../components/responses/404.yaml
72
+ '405':
73
+ $ref: ../components/responses/405.yaml
74
+ '406':
75
+ $ref: ../components/responses/406.yaml
76
+ '501':
77
+ $ref: ../components/responses/501.yaml
78
+ '503':
79
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,49 @@
1
+ put:
2
+ description: >-
3
+ If the server is unable to find or create a quote, or some other processing
4
+ error occurs, the error callback `PUT /quotes/{ID}/error` is used. The
5
+ `{ID}` in the URI should contain the `quoteId` that was used for the
6
+ creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}`
7
+ request.
8
+ summary: Return quote information error
9
+ tags:
10
+ - quotes
11
+ operationId: QuotesByIDAndError
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,73 @@
1
+ parameters:
2
+ - $ref: ../components/parameters/Content-Type.yaml
3
+ - $ref: ../components/parameters/Date.yaml
4
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
5
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
6
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
7
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
8
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
9
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
10
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
11
+ get:
12
+ description: >-
13
+ The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services.
14
+ summary: Obtain a list of the DFSPs in the scheme who provide FXP service
15
+ tags:
16
+ - servicesFXP
17
+ operationId: ServicesFXPGet
18
+ parameters:
19
+ - $ref: ../components/parameters/Accept.yaml
20
+ responses:
21
+ '202':
22
+ $ref: ../components/responses/202.yaml
23
+ '400':
24
+ $ref: ../components/responses/400.yaml
25
+ '401':
26
+ $ref: ../components/responses/401.yaml
27
+ '403':
28
+ $ref: ../components/responses/403.yaml
29
+ '404':
30
+ $ref: ../components/responses/404.yaml
31
+ '405':
32
+ $ref: ../components/responses/405.yaml
33
+ '406':
34
+ $ref: ../components/responses/406.yaml
35
+ '501':
36
+ $ref: ../components/responses/501.yaml
37
+ '503':
38
+ $ref: ../components/responses/503.yaml
39
+ put:
40
+ description: >-
41
+ The callback `PUT /services/FXP` is used to inform the requester about participants
42
+ in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank.
43
+ tags:
44
+ - servicesFXP
45
+ operationId: ServicesFXPPut
46
+ parameters:
47
+ - $ref: ../components/parameters/Content-Length.yaml
48
+ requestBody:
49
+ description: The list of participant(s) who offer currency conversion services.
50
+ required: true
51
+ content:
52
+ application/json:
53
+ schema:
54
+ $ref: ../components/schemas/ServicesFXPPutResponse.yaml
55
+ responses:
56
+ '200':
57
+ $ref: ../components/responses/200.yaml
58
+ '400':
59
+ $ref: ../components/responses/400.yaml
60
+ '401':
61
+ $ref: ../components/responses/401.yaml
62
+ '403':
63
+ $ref: ../components/responses/403.yaml
64
+ '404':
65
+ $ref: ../components/responses/404.yaml
66
+ '405':
67
+ $ref: ../components/responses/405.yaml
68
+ '406':
69
+ $ref: ../components/responses/406.yaml
70
+ '501':
71
+ $ref: ../components/responses/501.yaml
72
+ '503':
73
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,77 @@
1
+ parameters:
2
+ - $ref: ../components/parameters/SourceCurrency.yaml
3
+ - $ref: ../components/parameters/TargetCurrency.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
+ get:
14
+ description: >-
15
+ The HTTP request `GET /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to request information about the participants in a scheme who offer currency conversion services in a particular currency corridor.
16
+ The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency.
17
+ summary: Obtain a list of the DFSPs in the scheme who provide FXP service
18
+ tags:
19
+ - servicesFXP
20
+ operationId: ServicesFXPSourceCurrencyTargetCurrencyGet
21
+ parameters:
22
+ - $ref: ../components/parameters/Accept.yaml
23
+ responses:
24
+ '202':
25
+ $ref: ../components/responses/202.yaml
26
+ '400':
27
+ $ref: ../components/responses/400.yaml
28
+ '401':
29
+ $ref: ../components/responses/401.yaml
30
+ '403':
31
+ $ref: ../components/responses/403.yaml
32
+ '404':
33
+ $ref: ../components/responses/404.yaml
34
+ '405':
35
+ $ref: ../components/responses/405.yaml
36
+ '406':
37
+ $ref: ../components/responses/406.yaml
38
+ '501':
39
+ $ref: ../components/responses/501.yaml
40
+ '503':
41
+ $ref: ../components/responses/503.yaml
42
+ put:
43
+ description: >-
44
+ The callback `PUT /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to inform the requester about participants
45
+ in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank.
46
+ The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency.
47
+ tags:
48
+ - servicesFXP
49
+ operationId: ServicesFXPSourceCurrencyTargetCurrencyPut
50
+ parameters:
51
+ - $ref: ../components/parameters/Content-Length.yaml
52
+ requestBody:
53
+ description: The list of participant(s) who offer currency conversion services.
54
+ required: true
55
+ content:
56
+ application/json:
57
+ schema:
58
+ $ref: ../components/schemas/ServicesFXPSourceCurrencyTargetCurrencyPutResponse.yaml
59
+ responses:
60
+ '200':
61
+ $ref: ../components/responses/200.yaml
62
+ '400':
63
+ $ref: ../components/responses/400.yaml
64
+ '401':
65
+ $ref: ../components/responses/401.yaml
66
+ '403':
67
+ $ref: ../components/responses/403.yaml
68
+ '404':
69
+ $ref: ../components/responses/404.yaml
70
+ '405':
71
+ $ref: ../components/responses/405.yaml
72
+ '406':
73
+ $ref: ../components/responses/406.yaml
74
+ '501':
75
+ $ref: ../components/responses/501.yaml
76
+ '503':
77
+ $ref: ../components/responses/503.yaml
@@ -0,0 +1,47 @@
1
+ post:
2
+ description: >-
3
+ The HTTP request `POST /transactionRequests` is used to request the creation
4
+ of a transaction request for the provided financial transaction in the
5
+ server.
6
+ summary: Perform transaction request
7
+ tags:
8
+ - transactionRequests
9
+ operationId: TransactionRequests
10
+ parameters:
11
+ - $ref: ../components/parameters/Accept.yaml
12
+ - $ref: ../components/parameters/Content-Length.yaml
13
+ - $ref: ../components/parameters/Content-Type.yaml
14
+ - $ref: ../components/parameters/Date.yaml
15
+ - $ref: ../components/parameters/X-Forwarded-For.yaml
16
+ - $ref: ../components/parameters/FSPIOP-Source.yaml
17
+ - $ref: ../components/parameters/FSPIOP-Destination.yaml
18
+ - $ref: ../components/parameters/FSPIOP-Encryption.yaml
19
+ - $ref: ../components/parameters/FSPIOP-Signature.yaml
20
+ - $ref: ../components/parameters/FSPIOP-URI.yaml
21
+ - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
22
+ requestBody:
23
+ description: Transaction request to be created.
24
+ required: true
25
+ content:
26
+ application/json:
27
+ schema:
28
+ $ref: ../components/schemas/TransactionRequestsPostRequest.yaml
29
+ responses:
30
+ '202':
31
+ $ref: ../components/responses/202.yaml
32
+ '400':
33
+ $ref: ../components/responses/400.yaml
34
+ '401':
35
+ $ref: ../components/responses/401.yaml
36
+ '403':
37
+ $ref: ../components/responses/403.yaml
38
+ '404':
39
+ $ref: ../components/responses/404.yaml
40
+ '405':
41
+ $ref: ../components/responses/405.yaml
42
+ '406':
43
+ $ref: ../components/responses/406.yaml
44
+ '501':
45
+ $ref: ../components/responses/501.yaml
46
+ '503':
47
+ $ref: ../components/responses/503.yaml