ml-testing-toolkit 18.13.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 (319) hide show
  1. package/.dockerignore +10 -0
  2. package/.grype.yaml +16 -0
  3. package/.ncurc.yaml +9 -0
  4. package/.nvmrc +1 -0
  5. package/.versionrc.js +16 -0
  6. package/CHANGELOG.md +504 -0
  7. package/CODEOWNERS +30 -0
  8. package/Dockerfile +42 -0
  9. package/Dockerfile-newman +13 -0
  10. package/LICENSE.md +9 -0
  11. package/README.md +119 -0
  12. package/assets/diagrams/architectural/architectural-diagram.svg +3 -0
  13. package/assets/diagrams/flow/flow-diagram.svg +3 -0
  14. package/assets/images/Sample-Response-Failure.png +0 -0
  15. package/assets/images/Screenshot 2020-04-16 at 22.58.04.png +0 -0
  16. package/assets/images/TLS-Enabled-on-Environment.png +0 -0
  17. package/assets/images/adapter-mutual-tls-enabled.png +0 -0
  18. package/assets/images/add-additional-input-values.png +0 -0
  19. package/assets/images/add-condition-button.png +0 -0
  20. package/assets/images/add-new-assertion.png +0 -0
  21. package/assets/images/add-new-input-value.png +0 -0
  22. package/assets/images/add-new-input-variable.png +0 -0
  23. package/assets/images/additional-transfers.png +0 -0
  24. package/assets/images/api-provisioning-add-new-api-confirmation.png +0 -0
  25. package/assets/images/api-provisioning-file-input-window.png +0 -0
  26. package/assets/images/api-provisioning-list-apis-view.png +0 -0
  27. package/assets/images/api-provisioning-menu-item.png +0 -0
  28. package/assets/images/apply_and_restart.jpg +0 -0
  29. package/assets/images/assess-request-or-response.png +0 -0
  30. package/assets/images/assess-response-equation-save.png +0 -0
  31. package/assets/images/assess-response-equation.png +0 -0
  32. package/assets/images/assess-response-status.png +0 -0
  33. package/assets/images/building-new-rules-file.png +0 -0
  34. package/assets/images/callback-rules-screen.png +0 -0
  35. package/assets/images/configurable-parameter-assertion.png +0 -0
  36. package/assets/images/configurable-parameter-currency.png +0 -0
  37. package/assets/images/configurable-parameter.png +0 -0
  38. package/assets/images/connection-manager-ui-opening.png +0 -0
  39. package/assets/images/create-inbound-user-simulator.png +0 -0
  40. package/assets/images/creating-new-rule-file.png +0 -0
  41. package/assets/images/dfsp-client-cacert.png +0 -0
  42. package/assets/images/dfsp-client-submit.png +0 -0
  43. package/assets/images/dfsp-client.png +0 -0
  44. package/assets/images/dfsp-p2p-happy-path.png +0 -0
  45. package/assets/images/dfsp-server-cacert.png +0 -0
  46. package/assets/images/dfsp-server-cert.png +0 -0
  47. package/assets/images/download-report.png +0 -0
  48. package/assets/images/drive_have_not_been_shared.jpg +0 -0
  49. package/assets/images/event-response-options.png +0 -0
  50. package/assets/images/expand-monitoring-messages.png +0 -0
  51. package/assets/images/fixed-response-sample.png +0 -0
  52. package/assets/images/header-selection.png +0 -0
  53. package/assets/images/heap_error_windows.jpg +0 -0
  54. package/assets/images/hosted-mode-docker-compose-intro.png +0 -0
  55. package/assets/images/hub-client-cert.png +0 -0
  56. package/assets/images/import-template.png +0 -0
  57. package/assets/images/inbound-requests-environment.png +0 -0
  58. package/assets/images/inbound-requests-scripts.png +0 -0
  59. package/assets/images/jws-certificate-submit.png +0 -0
  60. package/assets/images/jws-certificate.png +0 -0
  61. package/assets/images/jws-certs-keys.png +0 -0
  62. package/assets/images/jws-hub-certs-keys.png +0 -0
  63. package/assets/images/local-enable-jws-publickey.png +0 -0
  64. package/assets/images/local-mutual-tls-enabled.png +0 -0
  65. package/assets/images/local_drives_to_be_available.jpg +0 -0
  66. package/assets/images/mcm-environment-opening.png +0 -0
  67. package/assets/images/menu-items.png +0 -0
  68. package/assets/images/mock-response-sample.png +0 -0
  69. package/assets/images/monitoring-initial-state.png +0 -0
  70. package/assets/images/monitoring-messages.png +0 -0
  71. package/assets/images/new-empty-assertion.png +0 -0
  72. package/assets/images/opened-imported-template.png +0 -0
  73. package/assets/images/opening-default-settings.png +0 -0
  74. package/assets/images/opening-sync-response-rules.png +0 -0
  75. package/assets/images/opening-view.png +0 -0
  76. package/assets/images/outbound-display-opening-hub.png +0 -0
  77. package/assets/images/outbound-display-opening.png +0 -0
  78. package/assets/images/override-with-environment-variable.png +0 -0
  79. package/assets/images/populate-with-sample-body.png +0 -0
  80. package/assets/images/resource-selection.png +0 -0
  81. package/assets/images/rule-builder-select-api.png +0 -0
  82. package/assets/images/sample-condition-add-configurable-params.png +0 -0
  83. package/assets/images/sample-condition.png +0 -0
  84. package/assets/images/sample-editor.png +0 -0
  85. package/assets/images/sample-request.png +0 -0
  86. package/assets/images/sample-test-assertion.png +0 -0
  87. package/assets/images/send-transfer.png +0 -0
  88. package/assets/images/sending-single-test-case-1.png +0 -0
  89. package/assets/images/sending-single-test-case-2.png +0 -0
  90. package/assets/images/sending-test-cases.png +0 -0
  91. package/assets/images/server-certificates-submitted.png +0 -0
  92. package/assets/images/simulator-response.png +0 -0
  93. package/assets/images/simulator-scheme-adapter-endpoint.png +0 -0
  94. package/assets/images/summarized-view-of-rule.png +0 -0
  95. package/assets/images/template-window.png +0 -0
  96. package/assets/images/test-case-editor-console-log.png +0 -0
  97. package/assets/images/test-case-editor-environment-state.png +0 -0
  98. package/assets/images/test-case-editor-scripts.png +0 -0
  99. package/assets/images/test-case-editor.png +0 -0
  100. package/assets/images/testcase-definition-download.png +0 -0
  101. package/assets/images/testcase-definition-edit-meta-info.png +0 -0
  102. package/assets/images/testing-toolkit-mojaloop-testing-toolkit-endpoint.png +0 -0
  103. package/assets/images/tls-hub-certs-keys.png +0 -0
  104. package/assets/images/tls-jws-enabled-on-environment.png +0 -0
  105. package/assets/images/updated-sample-body-data.png +0 -0
  106. package/assets/images/using-configurable-parameter.png +0 -0
  107. package/assets/images/validation-rules-screen.png +0 -0
  108. package/assets/images/view-response.png +0 -0
  109. package/audit-ci.jsonc +7 -0
  110. package/connection-manager/docker-compose.yml +55 -0
  111. package/database/docker-compose.yml +16 -0
  112. package/docker/hosted-mode/docker-compose.yaml +107 -0
  113. package/docker/hosted-mode/keycloak/keycloak-realm.json +2298 -0
  114. package/docker/hosted-mode/mongo-init.sh +1 -0
  115. package/docker/hosted-mode-tls/docker-compose.yaml +171 -0
  116. package/docker/hosted-mode-tls/keycloak/keycloak-realm.json +2298 -0
  117. package/docker/hosted-mode-tls/mongo-init.sh +1 -0
  118. package/docker-compose.yml +62 -0
  119. package/documents/Mojaloop-Testing-Toolkit.md +296 -0
  120. package/documents/RULES_ENGINE.md +403 -0
  121. package/documents/User-Guide-API-Provisioning.md +121 -0
  122. package/documents/User-Guide-CLI.md +218 -0
  123. package/documents/User-Guide-Connection-Manager.md +282 -0
  124. package/documents/User-Guide-Frequently-Asked-Questions.md +39 -0
  125. package/documents/User-Guide-Hosted-Mode-Docker-Compose.md +110 -0
  126. package/documents/User-Guide-Installation.md +163 -0
  127. package/documents/User-Guide-Mojaloop-Testing-Toolkit.md +642 -0
  128. package/documents/User-Guide-OAuth-Server-Deployment.md +283 -0
  129. package/documents/User-Guide-Onboarding-DFSP.md +197 -0
  130. package/documents/User-Guide-Onboarding-HUB.md +191 -0
  131. package/documents/User-Guide.md +53 -0
  132. package/examples/collections/dfsp/p2p_failed_tests.json +7161 -0
  133. package/examples/collections/dfsp/p2p_fx_happy_path.json +502 -0
  134. package/examples/collections/dfsp/p2p_happy_path.json +350 -0
  135. package/examples/collections/dfsp/p2p_happy_path_extended.json +6106 -0
  136. package/examples/collections/dfsp/p2p_happy_path_jws.json +511 -0
  137. package/examples/collections/dfsp/p2p_payee_assertions_websocket.json +441 -0
  138. package/examples/collections/dfsp/sample.json +5029 -0
  139. package/examples/collections/dfsp/transaction_request_service.json +240 -0
  140. package/examples/collections/fxp/FXP.json +264 -0
  141. package/examples/collections/fxp/SDK_backend.json +98 -0
  142. package/examples/collections/fxp/SDK_outbound.json +163 -0
  143. package/examples/collections/hub/hub_01_p2p_happy_path/hub_p2p_receive_quote.json +400 -0
  144. package/examples/collections/hub/hub_01_p2p_happy_path/hub_p2p_send_quote.json +395 -0
  145. package/examples/collections/hub/hub_02_block_transfer/hub_block_transfer.json +393 -0
  146. package/examples/collections/hub/hub_03_funds_in_out/hub_funds_in.json +224 -0
  147. package/examples/collections/hub/hub_03_funds_in_out/hub_funds_out.json +780 -0
  148. package/examples/collections/hub/hub_04_settlements/hub_settlements.json +3138 -0
  149. package/examples/collections/hub/hub_05_transfer_negative_scenarios/hub_transfer_negative_payee_abort.json +475 -0
  150. package/examples/collections/hub/hub_05_transfer_negative_scenarios/hub_transfer_negative_payee_invalid_fulfillment.json +370 -0
  151. package/examples/collections/hub/hub_05_transfer_negative_scenarios/hub_transfer_negative_transfer_timeout.json +262 -0
  152. package/examples/collections/hub/hub_06_transaction_requests_service/hub_trs_authorizations.json +117 -0
  153. package/examples/collections/hub/hub_06_transaction_requests_service/hub_trs_error_framework.json +591 -0
  154. package/examples/collections/hub/hub_06_transaction_requests_service/hub_trs_received_state.json +379 -0
  155. package/examples/collections/hub/hub_06_transaction_requests_service/hub_trs_reject_state.json +361 -0
  156. package/examples/collections/hub/hub_07_quoting_service.json +525 -0
  157. package/examples/collections/hub/hub_08_participant_inactive_stop_transfers.json +706 -0
  158. package/examples/collections/hub/hub_09_duplicate_handling_transfers.json +1377 -0
  159. package/examples/collections/hub/hub_10_on_us_transfers.json +245 -0
  160. package/examples/collections/hub/hub_11_accented_and_spl_chars.json +629 -0
  161. package/examples/collections/hub/hub_12_fspiop_version_1.1.json +646 -0
  162. package/examples/collections/hub/hub_13_bulk_transfers.json +1857 -0
  163. package/examples/collections/iso20022/self_referencing_iso20022.json +926 -0
  164. package/examples/collections/provisioning/testingtoolkitdfsp.json +904 -0
  165. package/examples/environments/dfsp_local_environment.json +46 -0
  166. package/examples/environments/hub_local_environment.json +57 -0
  167. package/jest.config.js +17 -0
  168. package/package.json +199 -0
  169. package/sbom-v18.12.4.csv +1553 -0
  170. package/secrets/keygen.sh +5 -0
  171. package/secrets/privatekey.pem +27 -0
  172. package/secrets/publickey.cer +21 -0
  173. package/secrets/tls/01.pem +132 -0
  174. package/secrets/tls/createSecrets.sh +20 -0
  175. package/secrets/tls/hub_client.csr +32 -0
  176. package/secrets/tls/hub_client_cacert.pem +35 -0
  177. package/secrets/tls/hub_client_cakey.pem +52 -0
  178. package/secrets/tls/hub_client_key.key +52 -0
  179. package/secrets/tls/hub_server.csr +31 -0
  180. package/secrets/tls/hub_server_cacert.pem +35 -0
  181. package/secrets/tls/hub_server_cakey.pem +52 -0
  182. package/secrets/tls/hub_server_cert.pem +132 -0
  183. package/secrets/tls/hub_server_key.key +52 -0
  184. package/secrets/tls/index.txt +1 -0
  185. package/secrets/tls/index.txt.attr +1 -0
  186. package/secrets/tls/openssl-client.cnf +36 -0
  187. package/secrets/tls/openssl-clientca.cnf +71 -0
  188. package/secrets/tls/openssl-server.cnf +39 -0
  189. package/secrets/tls/openssl-serverca.cnf +71 -0
  190. package/secrets/tls/serial.txt +1 -0
  191. package/spec_files/api_definitions/als_admin_1.1/api_spec.yaml +804 -0
  192. package/spec_files/api_definitions/central_admin_1.0/api_spec.yaml +1850 -0
  193. package/spec_files/api_definitions/central_admin_1.0/response_map.json +96 -0
  194. package/spec_files/api_definitions/central_admin_old_9.3/api_spec.yaml +2467 -0
  195. package/spec_files/api_definitions/central_admin_old_9.3/response_map.json +96 -0
  196. package/spec_files/api_definitions/fspiop_1.0/api_spec.yaml +4187 -0
  197. package/spec_files/api_definitions/fspiop_1.0/callback_map.json +568 -0
  198. package/spec_files/api_definitions/fspiop_1.0/mockRef.json +79 -0
  199. package/spec_files/api_definitions/fspiop_1.0/trigger_templates/transaction_request_followup.json +126 -0
  200. package/spec_files/api_definitions/fspiop_1.0/trigger_templates/transaction_request_followup_quotes_only.json +97 -0
  201. package/spec_files/api_definitions/fspiop_1.1/api_spec.yaml +3778 -0
  202. package/spec_files/api_definitions/fspiop_1.1/callback_map.json +568 -0
  203. package/spec_files/api_definitions/fspiop_1.1/mockRef.json +79 -0
  204. package/spec_files/api_definitions/fspiop_1.1/trigger_templates/transaction_request_followup.json +125 -0
  205. package/spec_files/api_definitions/fspiop_2.0/api_spec.yaml +4839 -0
  206. package/spec_files/api_definitions/fspiop_2.0/callback_map.json +716 -0
  207. package/spec_files/api_definitions/fspiop_2.0/mockRef.json +79 -0
  208. package/spec_files/api_definitions/fspiop_2.0/trigger_templates/transaction_request_followup.json +125 -0
  209. package/spec_files/api_definitions/fspiop_2.0_iso20022/api_spec.yaml +8331 -0
  210. package/spec_files/api_definitions/fspiop_2.0_iso20022/callback_map.json +508 -0
  211. package/spec_files/api_definitions/fspiop_2.0_iso20022/mockRef.json +66 -0
  212. package/spec_files/api_definitions/fx-api_2.0/api_spec.yaml +1768 -0
  213. package/spec_files/api_definitions/fx-api_2.0/callback_map.json +188 -0
  214. package/spec_files/api_definitions/fx-api_2.0/mockRef.json +83 -0
  215. package/spec_files/api_definitions/mojaloop_sdk_outbound_scheme_adapter_1.0/api_spec.yaml +2612 -0
  216. package/spec_files/api_definitions/mojaloop_sdk_outbound_scheme_adapter_1.0/mockRef.json +22 -0
  217. package/spec_files/api_definitions/mojaloop_sdk_outbound_scheme_adapter_1.0/response_map.json +35 -0
  218. package/spec_files/api_definitions/mojaloop_simulator_0.1/api_spec.yaml +225 -0
  219. package/spec_files/api_definitions/mojaloop_simulator_sim_1.4/api_spec.yaml +1087 -0
  220. package/spec_files/api_definitions/mojaloop_simulator_sim_1.4/mockRef.json +75 -0
  221. package/spec_files/api_definitions/mojaloop_simulator_sim_1.4/response_map.json +55 -0
  222. package/spec_files/api_definitions/payment_manager_1.4/api_spec.yaml +1389 -0
  223. package/spec_files/api_definitions/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets_2.1/api_spec.yaml +2834 -0
  224. package/spec_files/api_definitions/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets_2.1/api_spec.yaml +3449 -0
  225. package/spec_files/api_definitions/settlements_1.0/api_spec.yaml +983 -0
  226. package/spec_files/api_definitions/settlements_1.0/mockRef.json +38 -0
  227. package/spec_files/api_definitions/settlements_1.0/response_map.json +34 -0
  228. package/spec_files/api_definitions/settlements_2.0/api_spec.yaml +1001 -0
  229. package/spec_files/api_definitions/settlements_2.0/mockRef.json +38 -0
  230. package/spec_files/api_definitions/settlements_2.0/response_map.json +34 -0
  231. package/spec_files/api_definitions/thirdparty_sdk_outbound_0.1/api_spec.yaml +2139 -0
  232. package/spec_files/reports/templates/newman/html_template.html +1202 -0
  233. package/spec_files/reports/templates/newman/pdf_template.html +790 -0
  234. package/spec_files/reports/templates/testcase_definition/table_view.html +1602 -0
  235. package/spec_files/rules_callback/config.json +3 -0
  236. package/spec_files/rules_callback/default.json +2698 -0
  237. package/spec_files/rules_callback/p2p-limit.json +129 -0
  238. package/spec_files/rules_forward/config.json +3 -0
  239. package/spec_files/rules_forward/default.json +482 -0
  240. package/spec_files/rules_response/config.json +3 -0
  241. package/spec_files/rules_response/default.json +295 -0
  242. package/spec_files/rules_validation/config.json +3 -0
  243. package/spec_files/rules_validation/default.json +1 -0
  244. package/spec_files/rules_validation/p2p-limit.json +55 -0
  245. package/spec_files/system_config.json +175 -0
  246. package/spec_files/user_config.json +109 -0
  247. package/src/index.js +67 -0
  248. package/src/lib/MyEventEmitter.js +54 -0
  249. package/src/lib/api-management.js +143 -0
  250. package/src/lib/api-routes/config.js +83 -0
  251. package/src/lib/api-routes/history.js +139 -0
  252. package/src/lib/api-routes/keycloak.js +54 -0
  253. package/src/lib/api-routes/longpolling.js +70 -0
  254. package/src/lib/api-routes/oauth2.js +149 -0
  255. package/src/lib/api-routes/objectstore.js +53 -0
  256. package/src/lib/api-routes/openapi.js +224 -0
  257. package/src/lib/api-routes/outbound.js +134 -0
  258. package/src/lib/api-routes/reports.js +72 -0
  259. package/src/lib/api-routes/rules.js +356 -0
  260. package/src/lib/api-routes/samples.js +92 -0
  261. package/src/lib/api-routes/server-logs.js +44 -0
  262. package/src/lib/api-routes/settings.js +71 -0
  263. package/src/lib/api-server.js +135 -0
  264. package/src/lib/arrayStore.js +101 -0
  265. package/src/lib/callbackHandler.js +201 -0
  266. package/src/lib/config.js +177 -0
  267. package/src/lib/configuration-providers/mb-connection-manager.js +625 -0
  268. package/src/lib/db/adapters/dbAdapter.js +184 -0
  269. package/src/lib/db/dfspMockUsers.js +64 -0
  270. package/src/lib/db/models/mongoDBWrapper.js +78 -0
  271. package/src/lib/eventListenerClient/inboundEventListener.js +176 -0
  272. package/src/lib/fileAdapter.js +57 -0
  273. package/src/lib/httpAgentStore.js +135 -0
  274. package/src/lib/importExport.js +186 -0
  275. package/src/lib/jws/JwsSigning.js +141 -0
  276. package/src/lib/loadSamples.js +128 -0
  277. package/src/lib/logger.js +20 -0
  278. package/src/lib/longpollingEmitter.js +56 -0
  279. package/src/lib/metrics.js +51 -0
  280. package/src/lib/mocking/custom-functions/generic.js +57 -0
  281. package/src/lib/mocking/middleware-functions/ilpModel.js +238 -0
  282. package/src/lib/mocking/middleware-functions/quotesAssociation.js +75 -0
  283. package/src/lib/mocking/middleware-functions/transactionRequestsService.js +78 -0
  284. package/src/lib/mocking/openApiDefinitionsModel.js +64 -0
  285. package/src/lib/mocking/openApiMockHandler.js +466 -0
  286. package/src/lib/mocking/openApiRulesEngine.js +492 -0
  287. package/src/lib/mocking/openApiVersionTools.js +136 -0
  288. package/src/lib/mocking/transformers/fspiopToISO20022.js +230 -0
  289. package/src/lib/mocking/transformers/index.js +41 -0
  290. package/src/lib/notificationEmitter.js +64 -0
  291. package/src/lib/oauth/KeycloakHelper.js +220 -0
  292. package/src/lib/oauth/LoginService.js +133 -0
  293. package/src/lib/oauth/OAuthHelper.js +181 -0
  294. package/src/lib/oauth/OAuthValidator.js +118 -0
  295. package/src/lib/oauth/Wso2Client.js +64 -0
  296. package/src/lib/objectStore/inMemoryImpl.js +50 -0
  297. package/src/lib/objectStore/objectStoreInterface.js +51 -0
  298. package/src/lib/objectStore.js +122 -0
  299. package/src/lib/report-generator/generator.js +126 -0
  300. package/src/lib/report-generator/helpers.js +154 -0
  301. package/src/lib/requestLogger.js +190 -0
  302. package/src/lib/resources/wso2carbon-publickey.cert +20 -0
  303. package/src/lib/rulesEngine.js +95 -0
  304. package/src/lib/rulesEngineModel.js +463 -0
  305. package/src/lib/scripting-engines/postman-sandbox.js +142 -0
  306. package/src/lib/scripting-engines/vm-javascript-sandbox.js +294 -0
  307. package/src/lib/server-logs/adapters/elastic-search.js +102 -0
  308. package/src/lib/server-logs/adapters/grafana.js +0 -0
  309. package/src/lib/server-logs/index.js +75 -0
  310. package/src/lib/socket-server.js +55 -0
  311. package/src/lib/storageAdapter.js +109 -0
  312. package/src/lib/test-outbound/TestCaseRunner.js +173 -0
  313. package/src/lib/test-outbound/getTracing.js +19 -0
  314. package/src/lib/test-outbound/outbound-initiator.js +1107 -0
  315. package/src/lib/uniqueIdGenerator.js +35 -0
  316. package/src/lib/utils.js +89 -0
  317. package/src/lib/utilsInternal.js +56 -0
  318. package/src/lib/webSocketClient/WebSocketClientManager.js +197 -0
  319. package/src/server.js +218 -0
@@ -0,0 +1,3778 @@
1
+ openapi: "3.0.2"
2
+ info:
3
+ version: "1.1"
4
+ title: Open API for FSP Interoperability (FSPIOP)
5
+ description:
6
+ Based on [API Definition updated on 2020-05-19 Version 1.1](https://github.com/mojaloop/mojaloop-specification/blob/main/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
7
+
8
+
9
+ **Note:** The API supports a maximum size of 65536 bytes (64 Kilobytes) in the HTTP header.
10
+ license:
11
+ name: CC BY-ND 4.0
12
+ url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
13
+ contact:
14
+ name: "Sam Kummary"
15
+ url: https://github.com/mojaloop/mojaloop-specification/issues
16
+ servers:
17
+ - url: "{protocol}://hostname:<port>/switch/"
18
+ variables:
19
+ protocol:
20
+ enum:
21
+ - http
22
+ - https
23
+ default: https
24
+
25
+ paths:
26
+ #Participants
27
+ /participants/{Type}/{ID}:
28
+ parameters:
29
+ #Path
30
+ - $ref: "#/components/parameters/Type"
31
+ - $ref: "#/components/parameters/ID"
32
+ #Headers
33
+ - $ref: "#/components/parameters/Content-Type"
34
+ - $ref: "#/components/parameters/Date"
35
+ - $ref: "#/components/parameters/X-Forwarded-For"
36
+ - $ref: "#/components/parameters/FSPIOP-Source"
37
+ - $ref: "#/components/parameters/FSPIOP-Destination"
38
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
39
+ - $ref: "#/components/parameters/FSPIOP-Signature"
40
+ - $ref: "#/components/parameters/FSPIOP-URI"
41
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
42
+ post:
43
+ description: The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
44
+ summary: Create participant information
45
+ tags:
46
+ - participants
47
+ operationId: ParticipantsByIDAndType
48
+ parameters:
49
+ #Headers
50
+ - $ref: "#/components/parameters/Accept"
51
+ - $ref: "#/components/parameters/Content-Length"
52
+ requestBody:
53
+ description: Participant information to be created.
54
+ required: true
55
+ content:
56
+ application/json:
57
+ schema:
58
+ $ref: "#/components/schemas/ParticipantsTypeIDSubIDPostRequest"
59
+ responses:
60
+ 202:
61
+ $ref: "#/components/responses/202"
62
+ 400:
63
+ $ref: "#/components/responses/400"
64
+ 401:
65
+ $ref: "#/components/responses/401"
66
+ 403:
67
+ $ref: "#/components/responses/403"
68
+ 404:
69
+ $ref: "#/components/responses/404"
70
+ 405:
71
+ $ref: "#/components/responses/405"
72
+ 406:
73
+ $ref: "#/components/responses/406"
74
+ 501:
75
+ $ref: "#/components/responses/501"
76
+ 503:
77
+ $ref: "#/components/responses/503"
78
+ get:
79
+ description: The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
80
+ summary: Look up participant information
81
+ tags:
82
+ - participants
83
+ operationId: ParticipantsByTypeAndID
84
+ parameters:
85
+ #Headers
86
+ - $ref: "#/components/parameters/Accept"
87
+ responses:
88
+ 202:
89
+ $ref: "#/components/responses/202"
90
+ 400:
91
+ $ref: "#/components/responses/400"
92
+ 401:
93
+ $ref: "#/components/responses/401"
94
+ 403:
95
+ $ref: "#/components/responses/403"
96
+ 404:
97
+ $ref: "#/components/responses/404"
98
+ 405:
99
+ $ref: "#/components/responses/405"
100
+ 406:
101
+ $ref: "#/components/responses/406"
102
+ 501:
103
+ $ref: "#/components/responses/501"
104
+ 503:
105
+ $ref: "#/components/responses/503"
106
+ put:
107
+ description: The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
108
+ summary: Return participant information
109
+ tags:
110
+ - participants
111
+ operationId: ParticipantsByTypeAndID3
112
+ parameters:
113
+ #Headers
114
+ - $ref: "#/components/parameters/Content-Length"
115
+ requestBody:
116
+ description: Participant information returned.
117
+ required: true
118
+ content:
119
+ application/json:
120
+ schema:
121
+ $ref: "#/components/schemas/ParticipantsTypeIDPutResponse"
122
+ responses:
123
+ 200:
124
+ $ref: "#/components/responses/200"
125
+ 400:
126
+ $ref: "#/components/responses/400"
127
+ 401:
128
+ $ref: "#/components/responses/401"
129
+ 403:
130
+ $ref: "#/components/responses/403"
131
+ 404:
132
+ $ref: "#/components/responses/404"
133
+ 405:
134
+ $ref: "#/components/responses/405"
135
+ 406:
136
+ $ref: "#/components/responses/406"
137
+ 501:
138
+ $ref: "#/components/responses/501"
139
+ 503:
140
+ $ref: "#/components/responses/503"
141
+ delete:
142
+ description:
143
+ The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
144
+
145
+
146
+ **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
147
+ summary: Delete participant information
148
+ tags:
149
+ - participants
150
+ operationId: ParticipantsByTypeAndID2
151
+ parameters:
152
+ #Headers
153
+ - $ref: "#/components/parameters/Accept"
154
+ responses:
155
+ 202:
156
+ $ref: "#/components/responses/202"
157
+ 400:
158
+ $ref: "#/components/responses/400"
159
+ 401:
160
+ $ref: "#/components/responses/401"
161
+ 403:
162
+ $ref: "#/components/responses/403"
163
+ 404:
164
+ $ref: "#/components/responses/404"
165
+ 405:
166
+ $ref: "#/components/responses/405"
167
+ 406:
168
+ $ref: "#/components/responses/406"
169
+ 501:
170
+ $ref: "#/components/responses/501"
171
+ 503:
172
+ $ref: "#/components/responses/503"
173
+ /participants/{Type}/{ID}/error:
174
+ put:
175
+ description: If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
176
+ summary: Return participant information error
177
+ tags:
178
+ - participants
179
+ operationId: ParticipantsErrorByTypeAndID
180
+ parameters:
181
+ #Path
182
+ - $ref: "#/components/parameters/Type"
183
+ - $ref: "#/components/parameters/ID"
184
+ #Headers
185
+ - $ref: "#/components/parameters/Content-Length"
186
+ - $ref: "#/components/parameters/Content-Type"
187
+ - $ref: "#/components/parameters/Date"
188
+ - $ref: "#/components/parameters/X-Forwarded-For"
189
+ - $ref: "#/components/parameters/FSPIOP-Source"
190
+ - $ref: "#/components/parameters/FSPIOP-Destination"
191
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
192
+ - $ref: "#/components/parameters/FSPIOP-Signature"
193
+ - $ref: "#/components/parameters/FSPIOP-URI"
194
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
195
+ requestBody:
196
+ description: Details of the error returned.
197
+ required: true
198
+ content:
199
+ application/json:
200
+ schema:
201
+ $ref: "#/components/schemas/ErrorInformationObject"
202
+ responses:
203
+ 200:
204
+ $ref: "#/components/responses/200"
205
+ 400:
206
+ $ref: "#/components/responses/400"
207
+ 401:
208
+ $ref: "#/components/responses/401"
209
+ 403:
210
+ $ref: "#/components/responses/403"
211
+ 404:
212
+ $ref: "#/components/responses/404"
213
+ 405:
214
+ $ref: "#/components/responses/405"
215
+ 406:
216
+ $ref: "#/components/responses/406"
217
+ 501:
218
+ $ref: "#/components/responses/501"
219
+ 503:
220
+ $ref: "#/components/responses/503"
221
+ /participants/{Type}/{ID}/{SubId}:
222
+ parameters:
223
+ #Path
224
+ - $ref: "#/components/parameters/Type"
225
+ - $ref: "#/components/parameters/ID"
226
+ - $ref: "#/components/parameters/SubId"
227
+ #Headers
228
+ - $ref: "#/components/parameters/Content-Type"
229
+ - $ref: "#/components/parameters/Date"
230
+ - $ref: "#/components/parameters/X-Forwarded-For"
231
+ - $ref: "#/components/parameters/FSPIOP-Source"
232
+ - $ref: "#/components/parameters/FSPIOP-Destination"
233
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
234
+ - $ref: "#/components/parameters/FSPIOP-Signature"
235
+ - $ref: "#/components/parameters/FSPIOP-URI"
236
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
237
+ post:
238
+ description: The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
239
+ summary: Create participant information
240
+ tags:
241
+ - participants
242
+ operationId: ParticipantsSubIdByTypeAndIDPost
243
+ parameters:
244
+ #Headers
245
+ - $ref: "#/components/parameters/Accept"
246
+ - $ref: "#/components/parameters/Content-Length"
247
+ requestBody:
248
+ description: Participant information to be created.
249
+ required: true
250
+ content:
251
+ application/json:
252
+ schema:
253
+ $ref: "#/components/schemas/ParticipantsTypeIDSubIDPostRequest"
254
+ responses:
255
+ 202:
256
+ $ref: "#/components/responses/202"
257
+ 400:
258
+ $ref: "#/components/responses/400"
259
+ 401:
260
+ $ref: "#/components/responses/401"
261
+ 403:
262
+ $ref: "#/components/responses/403"
263
+ 404:
264
+ $ref: "#/components/responses/404"
265
+ 405:
266
+ $ref: "#/components/responses/405"
267
+ 406:
268
+ $ref: "#/components/responses/406"
269
+ 501:
270
+ $ref: "#/components/responses/501"
271
+ 503:
272
+ $ref: "#/components/responses/503"
273
+ get:
274
+ description: The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
275
+ summary: Look up participant information
276
+ tags:
277
+ - participants
278
+ operationId: ParticipantsSubIdByTypeAndID
279
+ parameters:
280
+ #Headers
281
+ - $ref: "#/components/parameters/Accept"
282
+ responses:
283
+ 202:
284
+ $ref: "#/components/responses/202"
285
+ 400:
286
+ $ref: "#/components/responses/400"
287
+ 401:
288
+ $ref: "#/components/responses/401"
289
+ 403:
290
+ $ref: "#/components/responses/403"
291
+ 404:
292
+ $ref: "#/components/responses/404"
293
+ 405:
294
+ $ref: "#/components/responses/405"
295
+ 406:
296
+ $ref: "#/components/responses/406"
297
+ 501:
298
+ $ref: "#/components/responses/501"
299
+ 503:
300
+ $ref: "#/components/responses/503"
301
+ put:
302
+ description: The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
303
+ summary: Return participant information
304
+ tags:
305
+ - participants
306
+ operationId: ParticipantsSubIdByTypeAndID3
307
+ parameters:
308
+ #Headers
309
+ - $ref: "#/components/parameters/Content-Length"
310
+ requestBody:
311
+ description: Participant information returned.
312
+ required: true
313
+ content:
314
+ application/json:
315
+ schema:
316
+ $ref: "#/components/schemas/ParticipantsTypeIDPutResponse"
317
+ responses:
318
+ 200:
319
+ $ref: "#/components/responses/200"
320
+ 400:
321
+ $ref: "#/components/responses/400"
322
+ 401:
323
+ $ref: "#/components/responses/401"
324
+ 403:
325
+ $ref: "#/components/responses/403"
326
+ 404:
327
+ $ref: "#/components/responses/404"
328
+ 405:
329
+ $ref: "#/components/responses/405"
330
+ 406:
331
+ $ref: "#/components/responses/406"
332
+ 501:
333
+ $ref: "#/components/responses/501"
334
+ 503:
335
+ $ref: "#/components/responses/503"
336
+ delete:
337
+ description:
338
+ The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
339
+
340
+
341
+ **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
342
+ summary: Delete participant information
343
+ tags:
344
+ - participants
345
+ operationId: ParticipantsSubIdByTypeAndID2
346
+ parameters:
347
+ #Headers
348
+ - $ref: "#/components/parameters/Accept"
349
+ responses:
350
+ 202:
351
+ $ref: "#/components/responses/202"
352
+ 400:
353
+ $ref: "#/components/responses/400"
354
+ 401:
355
+ $ref: "#/components/responses/401"
356
+ 403:
357
+ $ref: "#/components/responses/403"
358
+ 404:
359
+ $ref: "#/components/responses/404"
360
+ 405:
361
+ $ref: "#/components/responses/405"
362
+ 406:
363
+ $ref: "#/components/responses/406"
364
+ 501:
365
+ $ref: "#/components/responses/501"
366
+ 503:
367
+ $ref: "#/components/responses/503"
368
+ /participants/{Type}/{ID}/{SubId}/error:
369
+ put:
370
+ description: If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
371
+ summary: Return participant information error
372
+ tags:
373
+ - participants
374
+ operationId: ParticipantsSubIdErrorByTypeAndID
375
+ parameters:
376
+ #Path
377
+ - $ref: "#/components/parameters/Type"
378
+ - $ref: "#/components/parameters/ID"
379
+ - $ref: "#/components/parameters/SubId"
380
+ #Headers
381
+ - $ref: "#/components/parameters/Content-Length"
382
+ - $ref: "#/components/parameters/Content-Type"
383
+ - $ref: "#/components/parameters/Date"
384
+ - $ref: "#/components/parameters/X-Forwarded-For"
385
+ - $ref: "#/components/parameters/FSPIOP-Source"
386
+ - $ref: "#/components/parameters/FSPIOP-Destination"
387
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
388
+ - $ref: "#/components/parameters/FSPIOP-Signature"
389
+ - $ref: "#/components/parameters/FSPIOP-URI"
390
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
391
+ requestBody:
392
+ description: Details of the error returned.
393
+ required: true
394
+ content:
395
+ application/json:
396
+ schema:
397
+ $ref: "#/components/schemas/ErrorInformationObject"
398
+ responses:
399
+ 200:
400
+ $ref: "#/components/responses/200"
401
+ 400:
402
+ $ref: "#/components/responses/400"
403
+ 401:
404
+ $ref: "#/components/responses/401"
405
+ 403:
406
+ $ref: "#/components/responses/403"
407
+ 404:
408
+ $ref: "#/components/responses/404"
409
+ 405:
410
+ $ref: "#/components/responses/405"
411
+ 406:
412
+ $ref: "#/components/responses/406"
413
+ 501:
414
+ $ref: "#/components/responses/501"
415
+ 503:
416
+ $ref: "#/components/responses/503"
417
+ /participants:
418
+ post:
419
+ description: The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.
420
+ summary: Create bulk participant information
421
+ tags:
422
+ - participants
423
+ operationId: Participants1
424
+ parameters:
425
+ #Headers
426
+ - $ref: "#/components/parameters/Accept"
427
+ - $ref: "#/components/parameters/Content-Length"
428
+ - $ref: "#/components/parameters/Content-Type"
429
+ - $ref: "#/components/parameters/Date"
430
+ - $ref: "#/components/parameters/X-Forwarded-For"
431
+ - $ref: "#/components/parameters/FSPIOP-Source"
432
+ - $ref: "#/components/parameters/FSPIOP-Destination"
433
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
434
+ - $ref: "#/components/parameters/FSPIOP-Signature"
435
+ - $ref: "#/components/parameters/FSPIOP-URI"
436
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
437
+ requestBody:
438
+ description: Participant information to be created.
439
+ required: true
440
+ content:
441
+ application/json:
442
+ schema:
443
+ $ref: "#/components/schemas/ParticipantsPostRequest"
444
+ responses:
445
+ 202:
446
+ $ref: "#/components/responses/202"
447
+ 400:
448
+ $ref: "#/components/responses/400"
449
+ 401:
450
+ $ref: "#/components/responses/401"
451
+ 403:
452
+ $ref: "#/components/responses/403"
453
+ 404:
454
+ $ref: "#/components/responses/404"
455
+ 405:
456
+ $ref: "#/components/responses/405"
457
+ 406:
458
+ $ref: "#/components/responses/406"
459
+ 501:
460
+ $ref: "#/components/responses/501"
461
+ 503:
462
+ $ref: "#/components/responses/503"
463
+ /participants/{ID}:
464
+ put:
465
+ description: The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
466
+ summary: Return bulk participant information
467
+ tags:
468
+ - participants
469
+ operationId: putParticipantsByID
470
+ parameters:
471
+ #Path
472
+ - $ref: "#/components/parameters/ID"
473
+ #Headers
474
+ - $ref: "#/components/parameters/Content-Length"
475
+ - $ref: "#/components/parameters/Content-Type"
476
+ - $ref: "#/components/parameters/Date"
477
+ - $ref: "#/components/parameters/X-Forwarded-For"
478
+ - $ref: "#/components/parameters/FSPIOP-Source"
479
+ - $ref: "#/components/parameters/FSPIOP-Destination"
480
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
481
+ - $ref: "#/components/parameters/FSPIOP-Signature"
482
+ - $ref: "#/components/parameters/FSPIOP-URI"
483
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
484
+ requestBody:
485
+ description: Participant information returned.
486
+ required: true
487
+ content:
488
+ application/json:
489
+ schema:
490
+ $ref: "#/components/schemas/ParticipantsIDPutResponse"
491
+ responses:
492
+ 200:
493
+ $ref: "#/components/responses/200"
494
+ 400:
495
+ $ref: "#/components/responses/400"
496
+ 401:
497
+ $ref: "#/components/responses/401"
498
+ 403:
499
+ $ref: "#/components/responses/403"
500
+ 404:
501
+ $ref: "#/components/responses/404"
502
+ 405:
503
+ $ref: "#/components/responses/405"
504
+ 406:
505
+ $ref: "#/components/responses/406"
506
+ 501:
507
+ $ref: "#/components/responses/501"
508
+ 503:
509
+ $ref: "#/components/responses/503"
510
+ /participants/{ID}/error:
511
+ put:
512
+ description: If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information.
513
+ summary: Return bulk participant information error
514
+ tags:
515
+ - participants
516
+ operationId: ParticipantsByIDAndError
517
+ parameters:
518
+ #Path
519
+ - $ref: "#/components/parameters/ID"
520
+ #Headers
521
+ - $ref: "#/components/parameters/Content-Length"
522
+ - $ref: "#/components/parameters/Content-Type"
523
+ - $ref: "#/components/parameters/Date"
524
+ - $ref: "#/components/parameters/X-Forwarded-For"
525
+ - $ref: "#/components/parameters/FSPIOP-Source"
526
+ - $ref: "#/components/parameters/FSPIOP-Destination"
527
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
528
+ - $ref: "#/components/parameters/FSPIOP-Signature"
529
+ - $ref: "#/components/parameters/FSPIOP-URI"
530
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
531
+ requestBody:
532
+ description: Details of the error returned.
533
+ required: true
534
+ content:
535
+ application/json:
536
+ schema:
537
+ $ref: "#/components/schemas/ErrorInformationObject"
538
+ responses:
539
+ 200:
540
+ $ref: "#/components/responses/200"
541
+ 400:
542
+ $ref: "#/components/responses/400"
543
+ 401:
544
+ $ref: "#/components/responses/401"
545
+ 403:
546
+ $ref: "#/components/responses/403"
547
+ 404:
548
+ $ref: "#/components/responses/404"
549
+ 405:
550
+ $ref: "#/components/responses/405"
551
+ 406:
552
+ $ref: "#/components/responses/406"
553
+ 501:
554
+ $ref: "#/components/responses/501"
555
+ 503:
556
+ $ref: "#/components/responses/503"
557
+
558
+ #Parties
559
+ /parties/{Type}/{ID}:
560
+ parameters:
561
+ #Path
562
+ - $ref: "#/components/parameters/Type"
563
+ - $ref: "#/components/parameters/ID"
564
+ #Headers
565
+ - $ref: "#/components/parameters/Content-Type"
566
+ - $ref: "#/components/parameters/Date"
567
+ - $ref: "#/components/parameters/X-Forwarded-For"
568
+ - $ref: "#/components/parameters/FSPIOP-Source"
569
+ - $ref: "#/components/parameters/FSPIOP-Destination"
570
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
571
+ - $ref: "#/components/parameters/FSPIOP-Signature"
572
+ - $ref: "#/components/parameters/FSPIOP-URI"
573
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
574
+ get:
575
+ 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`).
576
+ summary: Look up party information
577
+ tags:
578
+ - parties
579
+ operationId: PartiesByTypeAndID
580
+ parameters:
581
+ #Headers
582
+ - $ref: "#/components/parameters/Accept"
583
+ responses:
584
+ 202:
585
+ $ref: "#/components/responses/202"
586
+ 400:
587
+ $ref: "#/components/responses/400"
588
+ 401:
589
+ $ref: "#/components/responses/401"
590
+ 403:
591
+ $ref: "#/components/responses/403"
592
+ 404:
593
+ $ref: "#/components/responses/404"
594
+ 405:
595
+ $ref: "#/components/responses/405"
596
+ 406:
597
+ $ref: "#/components/responses/406"
598
+ 501:
599
+ $ref: "#/components/responses/501"
600
+ 503:
601
+ $ref: "#/components/responses/503"
602
+ put:
603
+ 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.
604
+ summary: Return party information
605
+ tags:
606
+ - parties
607
+ operationId: PartiesByTypeAndID2
608
+ parameters:
609
+ #Headers
610
+ - $ref: "#/components/parameters/Content-Length"
611
+ requestBody:
612
+ description: Party information returned.
613
+ required: true
614
+ content:
615
+ application/json:
616
+ schema:
617
+ $ref: "#/components/schemas/PartiesTypeIDPutResponse"
618
+ responses:
619
+ 200:
620
+ $ref: "#/components/responses/200"
621
+ 400:
622
+ $ref: "#/components/responses/400"
623
+ 401:
624
+ $ref: "#/components/responses/401"
625
+ 403:
626
+ $ref: "#/components/responses/403"
627
+ 404:
628
+ $ref: "#/components/responses/404"
629
+ 405:
630
+ $ref: "#/components/responses/405"
631
+ 406:
632
+ $ref: "#/components/responses/406"
633
+ 501:
634
+ $ref: "#/components/responses/501"
635
+ 503:
636
+ $ref: "#/components/responses/503"
637
+ /parties/{Type}/{ID}/error:
638
+ put:
639
+ 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.
640
+ summary: Return party information error
641
+ tags:
642
+ - parties
643
+ operationId: PartiesErrorByTypeAndID
644
+ parameters:
645
+ #Path
646
+ - $ref: "#/components/parameters/Type"
647
+ - $ref: "#/components/parameters/ID"
648
+ #Headers
649
+ - $ref: "#/components/parameters/Content-Length"
650
+ - $ref: "#/components/parameters/Content-Type"
651
+ - $ref: "#/components/parameters/Date"
652
+ - $ref: "#/components/parameters/X-Forwarded-For"
653
+ - $ref: "#/components/parameters/FSPIOP-Source"
654
+ - $ref: "#/components/parameters/FSPIOP-Destination"
655
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
656
+ - $ref: "#/components/parameters/FSPIOP-Signature"
657
+ - $ref: "#/components/parameters/FSPIOP-URI"
658
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
659
+ requestBody:
660
+ description: Details of the error returned.
661
+ required: true
662
+ content:
663
+ application/json:
664
+ schema:
665
+ $ref: "#/components/schemas/ErrorInformationObject"
666
+ responses:
667
+ 200:
668
+ $ref: "#/components/responses/200"
669
+ 400:
670
+ $ref: "#/components/responses/400"
671
+ 401:
672
+ $ref: "#/components/responses/401"
673
+ 403:
674
+ $ref: "#/components/responses/403"
675
+ 404:
676
+ $ref: "#/components/responses/404"
677
+ 405:
678
+ $ref: "#/components/responses/405"
679
+ 406:
680
+ $ref: "#/components/responses/406"
681
+ 501:
682
+ $ref: "#/components/responses/501"
683
+ 503:
684
+ $ref: "#/components/responses/503"
685
+ /parties/{Type}/{ID}/{SubId}:
686
+ parameters:
687
+ #Path
688
+ - $ref: "#/components/parameters/Type"
689
+ - $ref: "#/components/parameters/ID"
690
+ - $ref: "#/components/parameters/SubId"
691
+ #Headers
692
+ - $ref: "#/components/parameters/Content-Type"
693
+ - $ref: "#/components/parameters/Date"
694
+ - $ref: "#/components/parameters/X-Forwarded-For"
695
+ - $ref: "#/components/parameters/FSPIOP-Source"
696
+ - $ref: "#/components/parameters/FSPIOP-Destination"
697
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
698
+ - $ref: "#/components/parameters/FSPIOP-Signature"
699
+ - $ref: "#/components/parameters/FSPIOP-URI"
700
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
701
+ get:
702
+ 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`).
703
+ summary: Look up party information
704
+ tags:
705
+ - parties
706
+ operationId: PartiesSubIdByTypeAndID
707
+ parameters:
708
+ #Headers
709
+ - $ref: "#/components/parameters/Accept"
710
+ responses:
711
+ 202:
712
+ $ref: "#/components/responses/202"
713
+ 400:
714
+ $ref: "#/components/responses/400"
715
+ 401:
716
+ $ref: "#/components/responses/401"
717
+ 403:
718
+ $ref: "#/components/responses/403"
719
+ 404:
720
+ $ref: "#/components/responses/404"
721
+ 405:
722
+ $ref: "#/components/responses/405"
723
+ 406:
724
+ $ref: "#/components/responses/406"
725
+ 501:
726
+ $ref: "#/components/responses/501"
727
+ 503:
728
+ $ref: "#/components/responses/503"
729
+ put:
730
+ 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.
731
+ summary: Return party information
732
+ tags:
733
+ - parties
734
+ operationId: PartiesSubIdByTypeAndIDPut
735
+ parameters:
736
+ #Headers
737
+ - $ref: "#/components/parameters/Content-Length"
738
+ requestBody:
739
+ description: Party information returned.
740
+ required: true
741
+ content:
742
+ application/json:
743
+ schema:
744
+ $ref: "#/components/schemas/PartiesTypeIDPutResponse"
745
+ responses:
746
+ 200:
747
+ $ref: "#/components/responses/200"
748
+ 400:
749
+ $ref: "#/components/responses/400"
750
+ 401:
751
+ $ref: "#/components/responses/401"
752
+ 403:
753
+ $ref: "#/components/responses/403"
754
+ 404:
755
+ $ref: "#/components/responses/404"
756
+ 405:
757
+ $ref: "#/components/responses/405"
758
+ 406:
759
+ $ref: "#/components/responses/406"
760
+ 501:
761
+ $ref: "#/components/responses/501"
762
+ 503:
763
+ $ref: "#/components/responses/503"
764
+ /parties/{Type}/{ID}/{SubId}/error:
765
+ put:
766
+ 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.
767
+ summary: Return party information error
768
+ tags:
769
+ - parties
770
+ operationId: PartiesSubIdErrorByTypeAndID
771
+ parameters:
772
+ #Path
773
+ - $ref: "#/components/parameters/Type"
774
+ - $ref: "#/components/parameters/ID"
775
+ - $ref: "#/components/parameters/SubId"
776
+ #Headers
777
+ - $ref: "#/components/parameters/Content-Length"
778
+ - $ref: "#/components/parameters/Content-Type"
779
+ - $ref: "#/components/parameters/Date"
780
+ - $ref: "#/components/parameters/X-Forwarded-For"
781
+ - $ref: "#/components/parameters/FSPIOP-Source"
782
+ - $ref: "#/components/parameters/FSPIOP-Destination"
783
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
784
+ - $ref: "#/components/parameters/FSPIOP-Signature"
785
+ - $ref: "#/components/parameters/FSPIOP-URI"
786
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
787
+ requestBody:
788
+ description: Details of the error returned.
789
+ required: true
790
+ content:
791
+ application/json:
792
+ schema:
793
+ $ref: "#/components/schemas/ErrorInformationObject"
794
+ responses:
795
+ 200:
796
+ $ref: "#/components/responses/200"
797
+ 400:
798
+ $ref: "#/components/responses/400"
799
+ 401:
800
+ $ref: "#/components/responses/401"
801
+ 403:
802
+ $ref: "#/components/responses/403"
803
+ 404:
804
+ $ref: "#/components/responses/404"
805
+ 405:
806
+ $ref: "#/components/responses/405"
807
+ 406:
808
+ $ref: "#/components/responses/406"
809
+ 501:
810
+ $ref: "#/components/responses/501"
811
+ 503:
812
+ $ref: "#/components/responses/503"
813
+
814
+ #Transaction requests
815
+ /transactionRequests:
816
+ post:
817
+ description: The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
818
+ summary: Perform transaction request
819
+ tags:
820
+ - transactionRequests
821
+ operationId: TransactionRequests
822
+ parameters:
823
+ #Headers
824
+ - $ref: "#/components/parameters/Accept"
825
+ - $ref: "#/components/parameters/Content-Length"
826
+ - $ref: "#/components/parameters/Content-Type"
827
+ - $ref: "#/components/parameters/Date"
828
+ - $ref: "#/components/parameters/X-Forwarded-For"
829
+ - $ref: "#/components/parameters/FSPIOP-Source"
830
+ - $ref: "#/components/parameters/FSPIOP-Destination"
831
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
832
+ - $ref: "#/components/parameters/FSPIOP-Signature"
833
+ - $ref: "#/components/parameters/FSPIOP-URI"
834
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
835
+ requestBody:
836
+ description: Transaction request to be created.
837
+ required: true
838
+ content:
839
+ application/json:
840
+ schema:
841
+ $ref: "#/components/schemas/TransactionRequestsPostRequest"
842
+ responses:
843
+ 202:
844
+ $ref: "#/components/responses/202"
845
+ 400:
846
+ $ref: "#/components/responses/400"
847
+ 401:
848
+ $ref: "#/components/responses/401"
849
+ 403:
850
+ $ref: "#/components/responses/403"
851
+ 404:
852
+ $ref: "#/components/responses/404"
853
+ 405:
854
+ $ref: "#/components/responses/405"
855
+ 406:
856
+ $ref: "#/components/responses/406"
857
+ 501:
858
+ $ref: "#/components/responses/501"
859
+ 503:
860
+ $ref: "#/components/responses/503"
861
+ /transactionRequests/{ID}:
862
+ parameters:
863
+ #Path
864
+ - $ref: "#/components/parameters/ID"
865
+ #Headers
866
+ - $ref: "#/components/parameters/Content-Type"
867
+ - $ref: "#/components/parameters/Date"
868
+ - $ref: "#/components/parameters/X-Forwarded-For"
869
+ - $ref: "#/components/parameters/FSPIOP-Source"
870
+ - $ref: "#/components/parameters/FSPIOP-Destination"
871
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
872
+ - $ref: "#/components/parameters/FSPIOP-Signature"
873
+ - $ref: "#/components/parameters/FSPIOP-URI"
874
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
875
+ get:
876
+ description: The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request.
877
+ summary: Retrieve transaction request information
878
+ tags:
879
+ - transactionRequests
880
+ operationId: TransactionRequestsByID
881
+ parameters:
882
+ #Headers
883
+ - $ref: "#/components/parameters/Accept"
884
+ responses:
885
+ 202:
886
+ $ref: "#/components/responses/202"
887
+ 400:
888
+ $ref: "#/components/responses/400"
889
+ 401:
890
+ $ref: "#/components/responses/401"
891
+ 403:
892
+ $ref: "#/components/responses/403"
893
+ 404:
894
+ $ref: "#/components/responses/404"
895
+ 405:
896
+ $ref: "#/components/responses/405"
897
+ 406:
898
+ $ref: "#/components/responses/406"
899
+ 501:
900
+ $ref: "#/components/responses/501"
901
+ 503:
902
+ $ref: "#/components/responses/503"
903
+ put:
904
+ description: The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
905
+ summary: Return transaction request information
906
+ tags:
907
+ - transactionRequests
908
+ operationId: TransactionRequestsByIDPut
909
+ parameters:
910
+ #Headers
911
+ - $ref: "#/components/parameters/Content-Length"
912
+ requestBody:
913
+ description: Transaction request information returned.
914
+ required: true
915
+ content:
916
+ application/json:
917
+ schema:
918
+ $ref: "#/components/schemas/TransactionRequestsIDPutResponse"
919
+ responses:
920
+ 200:
921
+ $ref: "#/components/responses/200"
922
+ 400:
923
+ $ref: "#/components/responses/400"
924
+ 401:
925
+ $ref: "#/components/responses/401"
926
+ 403:
927
+ $ref: "#/components/responses/403"
928
+ 404:
929
+ $ref: "#/components/responses/404"
930
+ 405:
931
+ $ref: "#/components/responses/405"
932
+ 406:
933
+ $ref: "#/components/responses/406"
934
+ 501:
935
+ $ref: "#/components/responses/501"
936
+ 503:
937
+ $ref: "#/components/responses/503"
938
+ /transactionRequests/{ID}/error:
939
+ put:
940
+ description: If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
941
+ summary: Return transaction request information error
942
+ tags:
943
+ - transactionRequests
944
+ operationId: TransactionRequestsErrorByID
945
+ parameters:
946
+ #Path
947
+ - $ref: "#/components/parameters/ID"
948
+ #Headers
949
+ - $ref: "#/components/parameters/Content-Length"
950
+ - $ref: "#/components/parameters/Content-Type"
951
+ - $ref: "#/components/parameters/Date"
952
+ - $ref: "#/components/parameters/X-Forwarded-For"
953
+ - $ref: "#/components/parameters/FSPIOP-Source"
954
+ - $ref: "#/components/parameters/FSPIOP-Destination"
955
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
956
+ - $ref: "#/components/parameters/FSPIOP-Signature"
957
+ - $ref: "#/components/parameters/FSPIOP-URI"
958
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
959
+ requestBody:
960
+ description: Details of the error returned.
961
+ required: true
962
+ content:
963
+ application/json:
964
+ schema:
965
+ $ref: "#/components/schemas/ErrorInformationObject"
966
+ responses:
967
+ 200:
968
+ $ref: "#/components/responses/200"
969
+ 400:
970
+ $ref: "#/components/responses/400"
971
+ 401:
972
+ $ref: "#/components/responses/401"
973
+ 403:
974
+ $ref: "#/components/responses/403"
975
+ 404:
976
+ $ref: "#/components/responses/404"
977
+ 405:
978
+ $ref: "#/components/responses/405"
979
+ 406:
980
+ $ref: "#/components/responses/406"
981
+ 501:
982
+ $ref: "#/components/responses/501"
983
+ 503:
984
+ $ref: "#/components/responses/503"
985
+
986
+ #Quotes
987
+ /quotes:
988
+ post:
989
+ description: The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
990
+ summary: Calculate quote
991
+ tags:
992
+ - quotes
993
+ operationId: Quotes
994
+ parameters:
995
+ #Headers
996
+ - $ref: "#/components/parameters/Accept"
997
+ - $ref: "#/components/parameters/Content-Length"
998
+ - $ref: "#/components/parameters/Content-Type"
999
+ - $ref: "#/components/parameters/Date"
1000
+ - $ref: "#/components/parameters/X-Forwarded-For"
1001
+ - $ref: "#/components/parameters/FSPIOP-Source"
1002
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1003
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1004
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1005
+ - $ref: "#/components/parameters/FSPIOP-URI"
1006
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1007
+ requestBody:
1008
+ description: Details of the quote to be created.
1009
+ required: true
1010
+ content:
1011
+ application/json:
1012
+ schema:
1013
+ $ref: "#/components/schemas/QuotesPostRequest"
1014
+ responses:
1015
+ 202:
1016
+ $ref: "#/components/responses/202"
1017
+ 400:
1018
+ $ref: "#/components/responses/400"
1019
+ 401:
1020
+ $ref: "#/components/responses/401"
1021
+ 403:
1022
+ $ref: "#/components/responses/403"
1023
+ 404:
1024
+ $ref: "#/components/responses/404"
1025
+ 405:
1026
+ $ref: "#/components/responses/405"
1027
+ 406:
1028
+ $ref: "#/components/responses/406"
1029
+ 501:
1030
+ $ref: "#/components/responses/501"
1031
+ 503:
1032
+ $ref: "#/components/responses/503"
1033
+ /quotes/{ID}:
1034
+ parameters:
1035
+ #Path
1036
+ - $ref: "#/components/parameters/ID"
1037
+ #Headers
1038
+ - $ref: "#/components/parameters/Content-Type"
1039
+ - $ref: "#/components/parameters/Date"
1040
+ - $ref: "#/components/parameters/X-Forwarded-For"
1041
+ - $ref: "#/components/parameters/FSPIOP-Source"
1042
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1043
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1044
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1045
+ - $ref: "#/components/parameters/FSPIOP-URI"
1046
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1047
+ get:
1048
+ description: The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote.
1049
+ summary: Retrieve quote information
1050
+ tags:
1051
+ - quotes
1052
+ operationId: QuotesByID
1053
+ parameters:
1054
+ #Headers
1055
+ - $ref: "#/components/parameters/Accept"
1056
+ responses:
1057
+ 202:
1058
+ $ref: "#/components/responses/202"
1059
+ 400:
1060
+ $ref: "#/components/responses/400"
1061
+ 401:
1062
+ $ref: "#/components/responses/401"
1063
+ 403:
1064
+ $ref: "#/components/responses/403"
1065
+ 404:
1066
+ $ref: "#/components/responses/404"
1067
+ 405:
1068
+ $ref: "#/components/responses/405"
1069
+ 406:
1070
+ $ref: "#/components/responses/406"
1071
+ 501:
1072
+ $ref: "#/components/responses/501"
1073
+ 503:
1074
+ $ref: "#/components/responses/503"
1075
+ put:
1076
+ description: The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
1077
+ summary: Return quote information
1078
+ tags:
1079
+ - quotes
1080
+ operationId: QuotesByID1
1081
+ parameters:
1082
+ #Headers
1083
+ - $ref: "#/components/parameters/Content-Length"
1084
+ requestBody:
1085
+ description: Quote information returned.
1086
+ required: true
1087
+ content:
1088
+ application/json:
1089
+ schema:
1090
+ $ref: "#/components/schemas/QuotesIDPutResponse"
1091
+ responses:
1092
+ 200:
1093
+ $ref: "#/components/responses/200"
1094
+ 400:
1095
+ $ref: "#/components/responses/400"
1096
+ 401:
1097
+ $ref: "#/components/responses/401"
1098
+ 403:
1099
+ $ref: "#/components/responses/403"
1100
+ 404:
1101
+ $ref: "#/components/responses/404"
1102
+ 405:
1103
+ $ref: "#/components/responses/405"
1104
+ 406:
1105
+ $ref: "#/components/responses/406"
1106
+ 501:
1107
+ $ref: "#/components/responses/501"
1108
+ 503:
1109
+ $ref: "#/components/responses/503"
1110
+ /quotes/{ID}/error:
1111
+ put:
1112
+ description: If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
1113
+ summary: Return quote information error
1114
+ tags:
1115
+ - quotes
1116
+ operationId: QuotesByIDAndError
1117
+ parameters:
1118
+ #Path
1119
+ - $ref: "#/components/parameters/ID"
1120
+ #Headers
1121
+ - $ref: "#/components/parameters/Content-Length"
1122
+ - $ref: "#/components/parameters/Content-Type"
1123
+ - $ref: "#/components/parameters/Date"
1124
+ - $ref: "#/components/parameters/X-Forwarded-For"
1125
+ - $ref: "#/components/parameters/FSPIOP-Source"
1126
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1127
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1128
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1129
+ - $ref: "#/components/parameters/FSPIOP-URI"
1130
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1131
+ requestBody:
1132
+ description: Details of the error returned.
1133
+ required: true
1134
+ content:
1135
+ application/json:
1136
+ schema:
1137
+ $ref: "#/components/schemas/ErrorInformationObject"
1138
+ responses:
1139
+ 200:
1140
+ $ref: "#/components/responses/200"
1141
+ 400:
1142
+ $ref: "#/components/responses/400"
1143
+ 401:
1144
+ $ref: "#/components/responses/401"
1145
+ 403:
1146
+ $ref: "#/components/responses/403"
1147
+ 404:
1148
+ $ref: "#/components/responses/404"
1149
+ 405:
1150
+ $ref: "#/components/responses/405"
1151
+ 406:
1152
+ $ref: "#/components/responses/406"
1153
+ 501:
1154
+ $ref: "#/components/responses/501"
1155
+ 503:
1156
+ $ref: "#/components/responses/503"
1157
+
1158
+ #Authorizations
1159
+ /authorizations/{ID}:
1160
+ parameters:
1161
+ #Path
1162
+ - $ref: "#/components/parameters/ID"
1163
+ #Headers
1164
+ - $ref: "#/components/parameters/Content-Type"
1165
+ - $ref: "#/components/parameters/Date"
1166
+ - $ref: "#/components/parameters/X-Forwarded-For"
1167
+ - $ref: "#/components/parameters/FSPIOP-Source"
1168
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1169
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1170
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1171
+ - $ref: "#/components/parameters/FSPIOP-URI"
1172
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1173
+ get:
1174
+ description:
1175
+ The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
1176
+
1177
+
1178
+ - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
1179
+
1180
+
1181
+ - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected.
1182
+
1183
+
1184
+ - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`.
1185
+
1186
+
1187
+ - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`.
1188
+
1189
+
1190
+ The following is an example URI containing all the required key-value pairs in the query string*:*
1191
+
1192
+
1193
+ `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102&currency=USD`
1194
+ summary: Perform authorization
1195
+ tags:
1196
+ - authorizations
1197
+ operationId: AuthorizationsByIDGet
1198
+ parameters:
1199
+ #Headers
1200
+ - $ref: "#/components/parameters/Accept"
1201
+ responses:
1202
+ 202:
1203
+ $ref: "#/components/responses/202"
1204
+ 400:
1205
+ $ref: "#/components/responses/400"
1206
+ 401:
1207
+ $ref: "#/components/responses/401"
1208
+ 403:
1209
+ $ref: "#/components/responses/403"
1210
+ 404:
1211
+ $ref: "#/components/responses/404"
1212
+ 405:
1213
+ $ref: "#/components/responses/405"
1214
+ 406:
1215
+ $ref: "#/components/responses/406"
1216
+ 501:
1217
+ $ref: "#/components/responses/501"
1218
+ 503:
1219
+ $ref: "#/components/responses/503"
1220
+ put:
1221
+ description: The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request.
1222
+ summary: Return authorization result
1223
+ tags:
1224
+ - authorizations
1225
+ operationId: AuthorizationsByIDPut
1226
+ parameters:
1227
+ #Headers
1228
+ - $ref: "#/components/parameters/Content-Length"
1229
+ requestBody:
1230
+ description: Authorization result returned.
1231
+ required: true
1232
+ content:
1233
+ application/json:
1234
+ schema:
1235
+ $ref: "#/components/schemas/AuthorizationsIDPutResponse"
1236
+ responses:
1237
+ 200:
1238
+ $ref: "#/components/responses/200"
1239
+ 400:
1240
+ $ref: "#/components/responses/400"
1241
+ 401:
1242
+ $ref: "#/components/responses/401"
1243
+ 403:
1244
+ $ref: "#/components/responses/403"
1245
+ 404:
1246
+ $ref: "#/components/responses/404"
1247
+ 405:
1248
+ $ref: "#/components/responses/405"
1249
+ 406:
1250
+ $ref: "#/components/responses/406"
1251
+ 501:
1252
+ $ref: "#/components/responses/501"
1253
+ 503:
1254
+ $ref: "#/components/responses/503"
1255
+ /authorizations/{ID}/error:
1256
+ put:
1257
+ description: If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`.
1258
+ summary: Return authorization error
1259
+ tags:
1260
+ - authorizations
1261
+ operationId: AuthorizationsByIDAndError
1262
+ parameters:
1263
+ #Path
1264
+ - $ref: "#/components/parameters/ID"
1265
+ #Headers
1266
+ - $ref: "#/components/parameters/Content-Length"
1267
+ - $ref: "#/components/parameters/Content-Type"
1268
+ - $ref: "#/components/parameters/Date"
1269
+ - $ref: "#/components/parameters/X-Forwarded-For"
1270
+ - $ref: "#/components/parameters/FSPIOP-Source"
1271
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1272
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1273
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1274
+ - $ref: "#/components/parameters/FSPIOP-URI"
1275
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1276
+ requestBody:
1277
+ description: Details of the error returned.
1278
+ required: true
1279
+ content:
1280
+ application/json:
1281
+ schema:
1282
+ $ref: "#/components/schemas/ErrorInformationObject"
1283
+ responses:
1284
+ 200:
1285
+ $ref: "#/components/responses/200"
1286
+ 400:
1287
+ $ref: "#/components/responses/400"
1288
+ 401:
1289
+ $ref: "#/components/responses/401"
1290
+ 403:
1291
+ $ref: "#/components/responses/403"
1292
+ 404:
1293
+ $ref: "#/components/responses/404"
1294
+ 405:
1295
+ $ref: "#/components/responses/405"
1296
+ 406:
1297
+ $ref: "#/components/responses/406"
1298
+ 501:
1299
+ $ref: "#/components/responses/501"
1300
+ 503:
1301
+ $ref: "#/components/responses/503"
1302
+
1303
+ #Transfers
1304
+ /transfers:
1305
+ post:
1306
+ description: The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP.
1307
+ summary: Perform transfer
1308
+ tags:
1309
+ - transfers
1310
+ operationId: transfers
1311
+ parameters:
1312
+ #Headers
1313
+ - $ref: "#/components/parameters/Accept"
1314
+ - $ref: "#/components/parameters/Content-Length"
1315
+ - $ref: "#/components/parameters/Content-Type"
1316
+ - $ref: "#/components/parameters/Date"
1317
+ - $ref: "#/components/parameters/X-Forwarded-For"
1318
+ - $ref: "#/components/parameters/FSPIOP-Source"
1319
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1320
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1321
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1322
+ - $ref: "#/components/parameters/FSPIOP-URI"
1323
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1324
+ requestBody:
1325
+ description: Details of the transfer to be created.
1326
+ required: true
1327
+ content:
1328
+ application/json:
1329
+ schema:
1330
+ $ref: "#/components/schemas/TransfersPostRequest"
1331
+ responses:
1332
+ 202:
1333
+ $ref: "#/components/responses/202"
1334
+ 400:
1335
+ $ref: "#/components/responses/400"
1336
+ 401:
1337
+ $ref: "#/components/responses/401"
1338
+ 403:
1339
+ $ref: "#/components/responses/403"
1340
+ 404:
1341
+ $ref: "#/components/responses/404"
1342
+ 405:
1343
+ $ref: "#/components/responses/405"
1344
+ 406:
1345
+ $ref: "#/components/responses/406"
1346
+ 501:
1347
+ $ref: "#/components/responses/501"
1348
+ 503:
1349
+ $ref: "#/components/responses/503"
1350
+ /transfers/{ID}:
1351
+ parameters:
1352
+ #Path
1353
+ - $ref: "#/components/parameters/ID"
1354
+ #Headers
1355
+ - $ref: "#/components/parameters/Content-Type"
1356
+ - $ref: "#/components/parameters/Date"
1357
+ - $ref: "#/components/parameters/X-Forwarded-For"
1358
+ - $ref: "#/components/parameters/FSPIOP-Source"
1359
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1360
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1361
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1362
+ - $ref: "#/components/parameters/FSPIOP-URI"
1363
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1364
+ get:
1365
+ description: The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer.
1366
+ summary: Retrieve transfer information
1367
+ tags:
1368
+ - transfers
1369
+ operationId: TransfersByIDGet
1370
+ parameters:
1371
+ #Headers
1372
+ - $ref: "#/components/parameters/Accept"
1373
+ responses:
1374
+ 202:
1375
+ $ref: "#/components/responses/202"
1376
+ 400:
1377
+ $ref: "#/components/responses/400"
1378
+ 401:
1379
+ $ref: "#/components/responses/401"
1380
+ 403:
1381
+ $ref: "#/components/responses/403"
1382
+ 404:
1383
+ $ref: "#/components/responses/404"
1384
+ 405:
1385
+ $ref: "#/components/responses/405"
1386
+ 406:
1387
+ $ref: "#/components/responses/406"
1388
+ 501:
1389
+ $ref: "#/components/responses/501"
1390
+ 503:
1391
+ $ref: "#/components/responses/503"
1392
+ patch:
1393
+ description: The HTTP request PATCH /transfers/<ID> is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The <ID> in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback.
1394
+ summary: Return transfer information
1395
+ tags:
1396
+ - transfers
1397
+ operationId: TransfersByIDPatch
1398
+ parameters:
1399
+ #Headers
1400
+ - $ref: "#/components/parameters/Content-Length"
1401
+ requestBody:
1402
+ description: Transfer notification upon completion.
1403
+ required: true
1404
+ content:
1405
+ application/json:
1406
+ schema:
1407
+ $ref: "#/components/schemas/TransfersIDPatchResponse"
1408
+ responses:
1409
+ 200:
1410
+ $ref: "#/components/responses/200"
1411
+ 400:
1412
+ $ref: "#/components/responses/400"
1413
+ 401:
1414
+ $ref: "#/components/responses/401"
1415
+ 403:
1416
+ $ref: "#/components/responses/403"
1417
+ 404:
1418
+ $ref: "#/components/responses/404"
1419
+ 405:
1420
+ $ref: "#/components/responses/405"
1421
+ 406:
1422
+ $ref: "#/components/responses/406"
1423
+ 501:
1424
+ $ref: "#/components/responses/501"
1425
+ 503:
1426
+ $ref: "#/components/responses/503"
1427
+ put:
1428
+ description: The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request.
1429
+ summary: Return transfer information
1430
+ tags:
1431
+ - transfers
1432
+ operationId: TransfersByIDPut
1433
+ parameters:
1434
+ #Headers
1435
+ - $ref: "#/components/parameters/Content-Length"
1436
+ requestBody:
1437
+ description: Transfer information returned.
1438
+ required: true
1439
+ content:
1440
+ application/json:
1441
+ schema:
1442
+ $ref: "#/components/schemas/TransfersIDPutResponse"
1443
+ responses:
1444
+ 200:
1445
+ $ref: "#/components/responses/200"
1446
+ 400:
1447
+ $ref: "#/components/responses/400"
1448
+ 401:
1449
+ $ref: "#/components/responses/401"
1450
+ 403:
1451
+ $ref: "#/components/responses/403"
1452
+ 404:
1453
+ $ref: "#/components/responses/404"
1454
+ 405:
1455
+ $ref: "#/components/responses/405"
1456
+ 406:
1457
+ $ref: "#/components/responses/406"
1458
+ 501:
1459
+ $ref: "#/components/responses/501"
1460
+ 503:
1461
+ $ref: "#/components/responses/503"
1462
+ /transfers/{ID}/error:
1463
+ put:
1464
+ description: If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`.
1465
+ summary: Return transfer information error
1466
+ tags:
1467
+ - transfers
1468
+ operationId: TransfersByIDAndError
1469
+ parameters:
1470
+ #Path
1471
+ - $ref: "#/components/parameters/ID"
1472
+ #Headers
1473
+ - $ref: "#/components/parameters/Content-Length"
1474
+ - $ref: "#/components/parameters/Content-Type"
1475
+ - $ref: "#/components/parameters/Date"
1476
+ - $ref: "#/components/parameters/X-Forwarded-For"
1477
+ - $ref: "#/components/parameters/FSPIOP-Source"
1478
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1479
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1480
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1481
+ - $ref: "#/components/parameters/FSPIOP-URI"
1482
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1483
+ requestBody:
1484
+ description: Details of the error returned.
1485
+ required: true
1486
+ content:
1487
+ application/json:
1488
+ schema:
1489
+ $ref: "#/components/schemas/ErrorInformationObject"
1490
+ responses:
1491
+ 200:
1492
+ $ref: "#/components/responses/200"
1493
+ 400:
1494
+ $ref: "#/components/responses/400"
1495
+ 401:
1496
+ $ref: "#/components/responses/401"
1497
+ 403:
1498
+ $ref: "#/components/responses/403"
1499
+ 404:
1500
+ $ref: "#/components/responses/404"
1501
+ 405:
1502
+ $ref: "#/components/responses/405"
1503
+ 406:
1504
+ $ref: "#/components/responses/406"
1505
+ 501:
1506
+ $ref: "#/components/responses/501"
1507
+ 503:
1508
+ $ref: "#/components/responses/503"
1509
+
1510
+ #Transactions
1511
+ /transactions/{ID}:
1512
+ parameters:
1513
+ - $ref: "#/components/parameters/ID"
1514
+ #Headers
1515
+ - $ref: "#/components/parameters/Content-Type"
1516
+ - $ref: "#/components/parameters/Date"
1517
+ - $ref: "#/components/parameters/X-Forwarded-For"
1518
+ - $ref: "#/components/parameters/FSPIOP-Source"
1519
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1520
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1521
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1522
+ - $ref: "#/components/parameters/FSPIOP-URI"
1523
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1524
+ get:
1525
+ description: The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process).
1526
+ summary: Retrieve transaction information
1527
+ tags:
1528
+ - transactions
1529
+ operationId: TransactionsByID
1530
+ parameters:
1531
+ #Headers
1532
+ - $ref: "#/components/parameters/Accept"
1533
+ responses:
1534
+ 202:
1535
+ $ref: "#/components/responses/202"
1536
+ 400:
1537
+ $ref: "#/components/responses/400"
1538
+ 401:
1539
+ $ref: "#/components/responses/401"
1540
+ 403:
1541
+ $ref: "#/components/responses/403"
1542
+ 404:
1543
+ $ref: "#/components/responses/404"
1544
+ 405:
1545
+ $ref: "#/components/responses/405"
1546
+ 406:
1547
+ $ref: "#/components/responses/406"
1548
+ 501:
1549
+ $ref: "#/components/responses/501"
1550
+ 503:
1551
+ $ref: "#/components/responses/503"
1552
+ put:
1553
+ description: The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
1554
+ summary: Return transaction information
1555
+ tags:
1556
+ - transactions
1557
+ operationId: TransactionsByID1
1558
+ parameters:
1559
+ #Headers
1560
+ - $ref: "#/components/parameters/Content-Length"
1561
+ requestBody:
1562
+ description: Transaction information returned.
1563
+ required: true
1564
+ content:
1565
+ application/json:
1566
+ schema:
1567
+ $ref: "#/components/schemas/TransactionsIDPutResponse"
1568
+ responses:
1569
+ 200:
1570
+ $ref: "#/components/responses/200"
1571
+ 400:
1572
+ $ref: "#/components/responses/400"
1573
+ 401:
1574
+ $ref: "#/components/responses/401"
1575
+ 403:
1576
+ $ref: "#/components/responses/403"
1577
+ 404:
1578
+ $ref: "#/components/responses/404"
1579
+ 405:
1580
+ $ref: "#/components/responses/405"
1581
+ 406:
1582
+ $ref: "#/components/responses/406"
1583
+ 501:
1584
+ $ref: "#/components/responses/501"
1585
+ 503:
1586
+ $ref: "#/components/responses/503"
1587
+ /transactions/{ID}/error:
1588
+ put:
1589
+ description: If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
1590
+ summary: Return transaction information error
1591
+ tags:
1592
+ - transactions
1593
+ operationId: TransactionsErrorByID
1594
+ parameters:
1595
+ #Path
1596
+ - $ref: "#/components/parameters/ID"
1597
+ #Headers
1598
+ - $ref: "#/components/parameters/Content-Length"
1599
+ - $ref: "#/components/parameters/Content-Type"
1600
+ - $ref: "#/components/parameters/Date"
1601
+ - $ref: "#/components/parameters/X-Forwarded-For"
1602
+ - $ref: "#/components/parameters/FSPIOP-Source"
1603
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1604
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1605
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1606
+ - $ref: "#/components/parameters/FSPIOP-URI"
1607
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1608
+ requestBody:
1609
+ description: Details of the error returned.
1610
+ required: true
1611
+ content:
1612
+ application/json:
1613
+ schema:
1614
+ $ref: "#/components/schemas/ErrorInformationObject"
1615
+ responses:
1616
+ 200:
1617
+ $ref: "#/components/responses/200"
1618
+ 400:
1619
+ $ref: "#/components/responses/400"
1620
+ 401:
1621
+ $ref: "#/components/responses/401"
1622
+ 403:
1623
+ $ref: "#/components/responses/403"
1624
+ 404:
1625
+ $ref: "#/components/responses/404"
1626
+ 405:
1627
+ $ref: "#/components/responses/405"
1628
+ 406:
1629
+ $ref: "#/components/responses/406"
1630
+ 501:
1631
+ $ref: "#/components/responses/501"
1632
+ 503:
1633
+ $ref: "#/components/responses/503"
1634
+
1635
+ #Bulk Quotes
1636
+ /bulkQuotes:
1637
+ post:
1638
+ description: The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
1639
+ summary: Calculate bulk quote
1640
+ tags:
1641
+ - bulkQuotes
1642
+ operationId: BulkQuotes
1643
+ parameters:
1644
+ #Headers
1645
+ - $ref: "#/components/parameters/Accept"
1646
+ - $ref: "#/components/parameters/Content-Length"
1647
+ - $ref: "#/components/parameters/Content-Type"
1648
+ - $ref: "#/components/parameters/Date"
1649
+ - $ref: "#/components/parameters/X-Forwarded-For"
1650
+ - $ref: "#/components/parameters/FSPIOP-Source"
1651
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1652
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1653
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1654
+ - $ref: "#/components/parameters/FSPIOP-URI"
1655
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1656
+ requestBody:
1657
+ description: Details of the bulk quote to be created.
1658
+ required: true
1659
+ content:
1660
+ application/json:
1661
+ schema:
1662
+ $ref: "#/components/schemas/BulkQuotesPostRequest"
1663
+ responses:
1664
+ 202:
1665
+ $ref: "#/components/responses/202"
1666
+ 400:
1667
+ $ref: "#/components/responses/400"
1668
+ 401:
1669
+ $ref: "#/components/responses/401"
1670
+ 403:
1671
+ $ref: "#/components/responses/403"
1672
+ 404:
1673
+ $ref: "#/components/responses/404"
1674
+ 405:
1675
+ $ref: "#/components/responses/405"
1676
+ 406:
1677
+ $ref: "#/components/responses/406"
1678
+ 501:
1679
+ $ref: "#/components/responses/501"
1680
+ 503:
1681
+ $ref: "#/components/responses/503"
1682
+ /bulkQuotes/{ID}:
1683
+ parameters:
1684
+ #Path
1685
+ - $ref: "#/components/parameters/ID"
1686
+ #Headers
1687
+ - $ref: "#/components/parameters/Content-Type"
1688
+ - $ref: "#/components/parameters/Date"
1689
+ - $ref: "#/components/parameters/X-Forwarded-For"
1690
+ - $ref: "#/components/parameters/FSPIOP-Source"
1691
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1692
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1693
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1694
+ - $ref: "#/components/parameters/FSPIOP-URI"
1695
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1696
+ get:
1697
+ description: The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
1698
+ summary: Retrieve bulk quote information
1699
+ tags:
1700
+ - bulkQuotes
1701
+ operationId: BulkQuotesByID
1702
+ parameters:
1703
+ #Headers
1704
+ - $ref: "#/components/parameters/Accept"
1705
+ responses:
1706
+ 202:
1707
+ $ref: "#/components/responses/202"
1708
+ 400:
1709
+ $ref: "#/components/responses/400"
1710
+ 401:
1711
+ $ref: "#/components/responses/401"
1712
+ 403:
1713
+ $ref: "#/components/responses/403"
1714
+ 404:
1715
+ $ref: "#/components/responses/404"
1716
+ 405:
1717
+ $ref: "#/components/responses/405"
1718
+ 406:
1719
+ $ref: "#/components/responses/406"
1720
+ 501:
1721
+ $ref: "#/components/responses/501"
1722
+ 503:
1723
+ $ref: "#/components/responses/503"
1724
+ put:
1725
+ description: The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
1726
+ summary: Return bulk quote information
1727
+ tags:
1728
+ - bulkQuotes
1729
+ operationId: BulkQuotesByID1
1730
+ parameters:
1731
+ #Headers
1732
+ - $ref: "#/components/parameters/Content-Length"
1733
+ requestBody:
1734
+ description: Bulk quote information returned.
1735
+ required: true
1736
+ content:
1737
+ application/json:
1738
+ schema:
1739
+ $ref: "#/components/schemas/BulkQuotesIDPutResponse"
1740
+ responses:
1741
+ 200:
1742
+ $ref: "#/components/responses/200"
1743
+ 400:
1744
+ $ref: "#/components/responses/400"
1745
+ 401:
1746
+ $ref: "#/components/responses/401"
1747
+ 403:
1748
+ $ref: "#/components/responses/403"
1749
+ 404:
1750
+ $ref: "#/components/responses/404"
1751
+ 405:
1752
+ $ref: "#/components/responses/405"
1753
+ 406:
1754
+ $ref: "#/components/responses/406"
1755
+ 501:
1756
+ $ref: "#/components/responses/501"
1757
+ 503:
1758
+ $ref: "#/components/responses/503"
1759
+ /bulkQuotes/{ID}/error:
1760
+ put:
1761
+ description: If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
1762
+ summary: Return bulk quote information error
1763
+ tags:
1764
+ - bulkQuotes
1765
+ operationId: BulkQuotesErrorByID
1766
+ parameters:
1767
+ #Path
1768
+ - $ref: "#/components/parameters/ID"
1769
+ #Headers
1770
+ - $ref: "#/components/parameters/Content-Length"
1771
+ - $ref: "#/components/parameters/Content-Type"
1772
+ - $ref: "#/components/parameters/Date"
1773
+ - $ref: "#/components/parameters/X-Forwarded-For"
1774
+ - $ref: "#/components/parameters/FSPIOP-Source"
1775
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1776
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1777
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1778
+ - $ref: "#/components/parameters/FSPIOP-URI"
1779
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1780
+ requestBody:
1781
+ description: Details of the error returned.
1782
+ required: true
1783
+ content:
1784
+ application/json:
1785
+ schema:
1786
+ $ref: "#/components/schemas/ErrorInformationObject"
1787
+ responses:
1788
+ 200:
1789
+ $ref: "#/components/responses/200"
1790
+ 400:
1791
+ $ref: "#/components/responses/400"
1792
+ 401:
1793
+ $ref: "#/components/responses/401"
1794
+ 403:
1795
+ $ref: "#/components/responses/403"
1796
+ 404:
1797
+ $ref: "#/components/responses/404"
1798
+ 405:
1799
+ $ref: "#/components/responses/405"
1800
+ 406:
1801
+ $ref: "#/components/responses/406"
1802
+ 501:
1803
+ $ref: "#/components/responses/501"
1804
+ 503:
1805
+ $ref: "#/components/responses/503"
1806
+
1807
+ #Bulk transfers
1808
+ /bulkTransfers:
1809
+ post:
1810
+ description: The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
1811
+ summary: Perform bulk transfer
1812
+ tags:
1813
+ - bulkTransfers
1814
+ operationId: BulkTransfers
1815
+ parameters:
1816
+ #Headers
1817
+ - $ref: "#/components/parameters/Accept"
1818
+ - $ref: "#/components/parameters/Content-Length"
1819
+ - $ref: "#/components/parameters/Content-Type"
1820
+ - $ref: "#/components/parameters/Date"
1821
+ - $ref: "#/components/parameters/X-Forwarded-For"
1822
+ - $ref: "#/components/parameters/FSPIOP-Source"
1823
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1824
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1825
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1826
+ - $ref: "#/components/parameters/FSPIOP-URI"
1827
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1828
+ requestBody:
1829
+ description: Details of the bulk transfer to be created.
1830
+ required: true
1831
+ content:
1832
+ application/json:
1833
+ schema:
1834
+ $ref: "#/components/schemas/BulkTransfersPostRequest"
1835
+ responses:
1836
+ 202:
1837
+ $ref: "#/components/responses/202"
1838
+ 400:
1839
+ $ref: "#/components/responses/400"
1840
+ 401:
1841
+ $ref: "#/components/responses/401"
1842
+ 403:
1843
+ $ref: "#/components/responses/403"
1844
+ 404:
1845
+ $ref: "#/components/responses/404"
1846
+ 405:
1847
+ $ref: "#/components/responses/405"
1848
+ 406:
1849
+ $ref: "#/components/responses/406"
1850
+ 501:
1851
+ $ref: "#/components/responses/501"
1852
+ 503:
1853
+ $ref: "#/components/responses/503"
1854
+ /bulkTransfers/{ID}:
1855
+ parameters:
1856
+ #Path
1857
+ - $ref: "#/components/parameters/ID"
1858
+ #Headers
1859
+ - $ref: "#/components/parameters/Content-Type"
1860
+ - $ref: "#/components/parameters/Date"
1861
+ - $ref: "#/components/parameters/X-Forwarded-For"
1862
+ - $ref: "#/components/parameters/FSPIOP-Source"
1863
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1864
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1865
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1866
+ - $ref: "#/components/parameters/FSPIOP-URI"
1867
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1868
+ get:
1869
+ description: The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
1870
+ summary: Retrieve bulk transfer information
1871
+ tags:
1872
+ - bulkTransfers
1873
+ operationId: BulkTransferByID
1874
+ parameters:
1875
+ #Headers
1876
+ - $ref: "#/components/parameters/Accept"
1877
+ responses:
1878
+ 202:
1879
+ $ref: "#/components/responses/202"
1880
+ 400:
1881
+ $ref: "#/components/responses/400"
1882
+ 401:
1883
+ $ref: "#/components/responses/401"
1884
+ 403:
1885
+ $ref: "#/components/responses/403"
1886
+ 404:
1887
+ $ref: "#/components/responses/404"
1888
+ 405:
1889
+ $ref: "#/components/responses/405"
1890
+ 406:
1891
+ $ref: "#/components/responses/406"
1892
+ 501:
1893
+ $ref: "#/components/responses/501"
1894
+ 503:
1895
+ $ref: "#/components/responses/503"
1896
+ put:
1897
+ description: The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
1898
+ summary: Return bulk transfer information
1899
+ tags:
1900
+ - bulkTransfers
1901
+ operationId: BulkTransfersByIDPut
1902
+ parameters:
1903
+ #Headers
1904
+ - $ref: "#/components/parameters/Content-Length"
1905
+ requestBody:
1906
+ description: Bulk transfer information returned.
1907
+ required: true
1908
+ content:
1909
+ application/json:
1910
+ schema:
1911
+ $ref: "#/components/schemas/BulkTransfersIDPutResponse"
1912
+ responses:
1913
+ 200:
1914
+ $ref: "#/components/responses/200"
1915
+ 400:
1916
+ $ref: "#/components/responses/400"
1917
+ 401:
1918
+ $ref: "#/components/responses/401"
1919
+ 403:
1920
+ $ref: "#/components/responses/403"
1921
+ 404:
1922
+ $ref: "#/components/responses/404"
1923
+ 405:
1924
+ $ref: "#/components/responses/405"
1925
+ 406:
1926
+ $ref: "#/components/responses/406"
1927
+ 501:
1928
+ $ref: "#/components/responses/501"
1929
+ 503:
1930
+ $ref: "#/components/responses/503"
1931
+ /bulkTransfers/{ID}/error:
1932
+ put:
1933
+ description: If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
1934
+ summary: Return bulk transfer information error
1935
+ tags:
1936
+ - bulkTransfers
1937
+ operationId: BulkTransfersErrorByID
1938
+ parameters:
1939
+ #Path
1940
+ - $ref: "#/components/parameters/ID"
1941
+ #Headers
1942
+ - $ref: "#/components/parameters/Content-Length"
1943
+ - $ref: "#/components/parameters/Content-Type"
1944
+ - $ref: "#/components/parameters/Date"
1945
+ - $ref: "#/components/parameters/X-Forwarded-For"
1946
+ - $ref: "#/components/parameters/FSPIOP-Source"
1947
+ - $ref: "#/components/parameters/FSPIOP-Destination"
1948
+ - $ref: "#/components/parameters/FSPIOP-Encryption"
1949
+ - $ref: "#/components/parameters/FSPIOP-Signature"
1950
+ - $ref: "#/components/parameters/FSPIOP-URI"
1951
+ - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
1952
+ requestBody:
1953
+ description: Details of the error returned.
1954
+ required: true
1955
+ content:
1956
+ application/json:
1957
+ schema:
1958
+ $ref: "#/components/schemas/ErrorInformationObject"
1959
+ responses:
1960
+ 200:
1961
+ $ref: "#/components/responses/200"
1962
+ 400:
1963
+ $ref: "#/components/responses/400"
1964
+ 401:
1965
+ $ref: "#/components/responses/401"
1966
+ 403:
1967
+ $ref: "#/components/responses/403"
1968
+ 404:
1969
+ $ref: "#/components/responses/404"
1970
+ 405:
1971
+ $ref: "#/components/responses/405"
1972
+ 406:
1973
+ $ref: "#/components/responses/406"
1974
+ 501:
1975
+ $ref: "#/components/responses/501"
1976
+ 503:
1977
+ $ref: "#/components/responses/503"
1978
+
1979
+ components:
1980
+ schemas:
1981
+ #Element definitions
1982
+ Amount:
1983
+ title: Amount
1984
+ type: string
1985
+ pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
1986
+ 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.
1987
+ AmountType:
1988
+ title: AmountType
1989
+ type: string
1990
+ enum:
1991
+ - SEND
1992
+ - RECEIVE
1993
+ description: Below are the allowed values for the enumeration AmountType.
1994
+
1995
+ - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
1996
+
1997
+ - 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.
1998
+ AuthenticationType:
1999
+ title: AuthenticationType
2000
+ type: string
2001
+ enum:
2002
+ - OTP
2003
+ - QRCODE
2004
+ description:
2005
+ Below are the allowed values for the enumeration AuthenticationType.
2006
+
2007
+ - OTP - One-time password generated by the Payer FSP.
2008
+
2009
+ - QRCODE - QR code used as One Time Password.
2010
+ AuthenticationValue:
2011
+ title: AuthenticationValue
2012
+ oneOf:
2013
+ - $ref: "#/components/schemas/OtpValue"
2014
+ - $ref: "#/components/schemas/QRCODE"
2015
+ pattern: ^\d{3,10}$|^\S{1,64}$
2016
+ description: Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
2017
+ AuthorizationResponse:
2018
+ title: AuthorizationResponse
2019
+ type: string
2020
+ enum:
2021
+ - ENTERED
2022
+ - REJECTED
2023
+ - RESEND
2024
+ description: Below are the allowed values for the enumeration.
2025
+
2026
+ - ENTERED - Consumer entered the authentication value.
2027
+
2028
+ - REJECTED - Consumer rejected the transaction.
2029
+
2030
+ - RESEND - Consumer requested to resend the authentication value.
2031
+ BalanceOfPayments:
2032
+ title: BalanceOfPayments
2033
+ type: string
2034
+ pattern: ^[1-9]\d{2}$
2035
+ 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.
2036
+ BulkTransferState:
2037
+ title: BulkTransactionState
2038
+ type: string
2039
+ enum:
2040
+ - RECEIVED
2041
+ - PENDING
2042
+ - ACCEPTED
2043
+ - PROCESSING
2044
+ - COMPLETED
2045
+ - REJECTED
2046
+ description: Below are the allowed values for the enumeration.
2047
+
2048
+ - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
2049
+
2050
+ - PENDING - Payee FSP has validated the bulk transfer.
2051
+
2052
+ - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
2053
+
2054
+ - PROCESSING - Payee FSP has started to transfer fund to the Payees.
2055
+
2056
+ - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
2057
+
2058
+ - REJECTED - Payee FSP has rejected to process the bulk transfer.
2059
+ Code:
2060
+ title: Code
2061
+ type: string
2062
+ pattern: ^[0-9a-zA-Z]{4,32}$
2063
+ description: Any code/token returned by the Payee FSP (TokenCode Type).
2064
+ CorrelationId:
2065
+ title: CorrelationId
2066
+ type: string
2067
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2068
+ 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 (‘-‘).
2069
+ Currency:
2070
+ title: Currency
2071
+ 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.
2072
+ type: string
2073
+ minLength: 3
2074
+ maxLength: 3
2075
+ enum:
2076
+ - AED
2077
+ - AFN
2078
+ - ALL
2079
+ - AMD
2080
+ - ANG
2081
+ - AOA
2082
+ - ARS
2083
+ - AUD
2084
+ - AWG
2085
+ - AZN
2086
+ - BAM
2087
+ - BBD
2088
+ - BDT
2089
+ - BGN
2090
+ - BHD
2091
+ - BIF
2092
+ - BMD
2093
+ - BND
2094
+ - BOB
2095
+ - BRL
2096
+ - BSD
2097
+ - BTN
2098
+ - BWP
2099
+ - BYN
2100
+ - BZD
2101
+ - CAD
2102
+ - CDF
2103
+ - CHF
2104
+ - CLP
2105
+ - CNY
2106
+ - COP
2107
+ - CRC
2108
+ - CUC
2109
+ - CUP
2110
+ - CVE
2111
+ - CZK
2112
+ - DJF
2113
+ - DKK
2114
+ - DOP
2115
+ - DZD
2116
+ - EGP
2117
+ - ERN
2118
+ - ETB
2119
+ - EUR
2120
+ - FJD
2121
+ - FKP
2122
+ - GBP
2123
+ - GEL
2124
+ - GGP
2125
+ - GHS
2126
+ - GIP
2127
+ - GMD
2128
+ - GNF
2129
+ - GTQ
2130
+ - GYD
2131
+ - HKD
2132
+ - HNL
2133
+ - HRK
2134
+ - HTG
2135
+ - HUF
2136
+ - IDR
2137
+ - ILS
2138
+ - IMP
2139
+ - INR
2140
+ - IQD
2141
+ - IRR
2142
+ - ISK
2143
+ - JEP
2144
+ - JMD
2145
+ - JOD
2146
+ - JPY
2147
+ - KES
2148
+ - KGS
2149
+ - KHR
2150
+ - KMF
2151
+ - KPW
2152
+ - KRW
2153
+ - KWD
2154
+ - KYD
2155
+ - KZT
2156
+ - LAK
2157
+ - LBP
2158
+ - LKR
2159
+ - LRD
2160
+ - LSL
2161
+ - LYD
2162
+ - MAD
2163
+ - MDL
2164
+ - MGA
2165
+ - MKD
2166
+ - MMK
2167
+ - MNT
2168
+ - MOP
2169
+ - MRO
2170
+ - MUR
2171
+ - MVR
2172
+ - MWK
2173
+ - MXN
2174
+ - MYR
2175
+ - MZN
2176
+ - NAD
2177
+ - NGN
2178
+ - NIO
2179
+ - NOK
2180
+ - NPR
2181
+ - NZD
2182
+ - OMR
2183
+ - PAB
2184
+ - PEN
2185
+ - PGK
2186
+ - PHP
2187
+ - PKR
2188
+ - PLN
2189
+ - PYG
2190
+ - QAR
2191
+ - RON
2192
+ - RSD
2193
+ - RUB
2194
+ - RWF
2195
+ - SAR
2196
+ - SBD
2197
+ - SCR
2198
+ - SDG
2199
+ - SEK
2200
+ - SGD
2201
+ - SHP
2202
+ - SLL
2203
+ - SOS
2204
+ - SPL
2205
+ - SRD
2206
+ - STD
2207
+ - SVC
2208
+ - SYP
2209
+ - SZL
2210
+ - THB
2211
+ - TJS
2212
+ - TMT
2213
+ - TND
2214
+ - TOP
2215
+ - TRY
2216
+ - TTD
2217
+ - TVD
2218
+ - TWD
2219
+ - TZS
2220
+ - UAH
2221
+ - UGX
2222
+ - USD
2223
+ - UYU
2224
+ - UZS
2225
+ - VEF
2226
+ - VND
2227
+ - VUV
2228
+ - WST
2229
+ - XAF
2230
+ - XCD
2231
+ - XDR
2232
+ - XOF
2233
+ - XPF
2234
+ - XTS
2235
+ - XXX
2236
+ - YER
2237
+ - ZAR
2238
+ - ZMW
2239
+ - ZWD
2240
+ DateOfBirth:
2241
+ title: DateofBirth (type Date)
2242
+ type: string
2243
+ 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)$
2244
+ description: Date of Birth of the Party.
2245
+ DateTime:
2246
+ title: DateTime
2247
+ type: string
2248
+ 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)$
2249
+ description:
2250
+ The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2251
+ 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).
2252
+ ErrorCode:
2253
+ title: ErrorCode
2254
+ type: string
2255
+ pattern: ^[1-9]\d{3}$
2256
+ 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.
2257
+ ErrorDescription:
2258
+ title: ErrorDescription
2259
+ type: string
2260
+ minLength: 1
2261
+ maxLength: 128
2262
+ description: Error description string.
2263
+ ExtensionKey:
2264
+ title: ExtensionKey
2265
+ type: string
2266
+ minLength: 1
2267
+ maxLength: 32
2268
+ description: Extension key.
2269
+ ExtensionValue:
2270
+ title: ExtensionValue
2271
+ type: string
2272
+ minLength: 1
2273
+ maxLength: 128
2274
+ description: Extension value.
2275
+ FirstName:
2276
+ title: FirstName
2277
+ type: string
2278
+ minLength: 1
2279
+ maxLength: 128
2280
+ pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
2281
+ description: First name of the Party (Name Type).
2282
+ FspId:
2283
+ title: FspId
2284
+ type: string
2285
+ minLength: 1
2286
+ maxLength: 32
2287
+ description: FSP identifier.
2288
+ IlpCondition:
2289
+ title: IlpCondition
2290
+ type: string
2291
+ pattern: ^[A-Za-z0-9-_]{43}$
2292
+ maxLength: 48
2293
+ description: Condition that must be attached to the transfer by the Payer.
2294
+ IlpFulfilment:
2295
+ title: IlpFulfilment
2296
+ type: string
2297
+ pattern: ^[A-Za-z0-9-_]{43}$
2298
+ maxLength: 48
2299
+ description: Fulfilment that must be attached to the transfer by the Payee.
2300
+ IlpPacket:
2301
+ title: IlpPacket
2302
+ type: string
2303
+ pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
2304
+ minLength: 1
2305
+ maxLength: 32768
2306
+ description: Information for recipient (transport layer information).
2307
+ LastName:
2308
+ title: LastName
2309
+ type: string
2310
+ minLength: 1
2311
+ maxLength: 128
2312
+ pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
2313
+ description: Last name of the Party (Name Type).
2314
+ Latitude:
2315
+ title: Latitude
2316
+ type: string
2317
+ pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
2318
+ description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2319
+ Longitude:
2320
+ title: Longitude
2321
+ type: string
2322
+ pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
2323
+ description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2324
+ MerchantClassificationCode:
2325
+ title: MerchantClassificationCode
2326
+ type: string
2327
+ pattern: ^[\d]{1,4}$
2328
+ 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.
2329
+ MiddleName:
2330
+ title: MiddleName
2331
+ type: string
2332
+ minLength: 1
2333
+ maxLength: 128
2334
+ pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
2335
+ description: Middle name of the Party (Name Type).
2336
+ Name:
2337
+ title: Name
2338
+ type: string
2339
+ pattern: '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'
2340
+ description:
2341
+ 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.
2342
+
2343
+
2344
+ Regular Expression - The regular expression for restricting the Name type is '^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$'. The restriction does not allow a string consisting of whitespace only, all Unicode characters are allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,) and space characters ( ).
2345
+
2346
+
2347
+ **Note:** In some programming languages, Unicode support must be specifically enabled. For example, if Java is used, the flag UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
2348
+ Note:
2349
+ title: Note
2350
+ type: string
2351
+ minLength: 1
2352
+ maxLength: 128
2353
+ description: Memo assigned to transaction.
2354
+ OtpValue:
2355
+ title: OtpValue
2356
+ type: string
2357
+ pattern: ^\d{3,10}$
2358
+ description: The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed.
2359
+ PartyIdentifier:
2360
+ title: PartyIdentifier
2361
+ type: string
2362
+ minLength: 1
2363
+ maxLength: 128
2364
+ description: Identifier of the Party.
2365
+ PartyIdType:
2366
+ title: PartyIdType
2367
+ type: string
2368
+ enum:
2369
+ - MSISDN
2370
+ - EMAIL
2371
+ - PERSONAL_ID
2372
+ - BUSINESS
2373
+ - DEVICE
2374
+ - ACCOUNT_ID
2375
+ - IBAN
2376
+ - ALIAS
2377
+ description: Below are the allowed values for the enumeration.
2378
+
2379
+ - MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.
2380
+
2381
+ - EMAIL - An email is used as reference to a participant. The format of the email should be according to the informational [RFC 3696](https://tools.ietf.org/html/rfc3696).
2382
+
2383
+ - PERSONAL_ID - A personal identifier is used as reference to a participant. Examples of personal identification are passport number, birth certificate number, and national registration number. The identifier number is added in the PartyIdentifier element. The personal identifier type is added in the PartySubIdOrType element.
2384
+
2385
+ - BUSINESS - A specific Business (for example, an organization or a company) is used as reference to a participant. The BUSINESS identifier can be in any format. To make a transaction connected to a specific username or bill number in a Business, the PartySubIdOrType element should be used.
2386
+
2387
+ - DEVICE - A specific device (for example, a POS or ATM) ID connected to a specific business or organization is used as reference to a Party. For referencing a specific device under a specific business or organization, use the PartySubIdOrType element.
2388
+
2389
+ - ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.
2390
+
2391
+ - IBAN - A bank account number or FSP account ID is used as reference to a participant. The IBAN identifier can consist of up to 34 alphanumeric characters and should be entered without whitespace.
2392
+
2393
+ - ALIAS An alias is used as reference to a participant. The alias should be created in the FSP as an alternative reference to an account owner. Another example of an alias is a username in the FSP system. The ALIAS identifier can be in any format. It is also possible to use the PartySubIdOrType element for identifying an account under an Alias defined by the PartyIdentifier.
2394
+ PartyName:
2395
+ title: PartyName
2396
+ allOf:
2397
+ - $ref: "#/components/schemas/Name"
2398
+ - description: Name of the Party. Could be a real name or a nickname.
2399
+ PartySubIdOrType:
2400
+ title: PartySubIdOrType
2401
+ description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
2402
+ oneOf:
2403
+ - $ref: "#/components/schemas/PersonalIdentifierType"
2404
+ - $ref: "#/components/schemas/PartyIdentifier"
2405
+ PersonalIdentifierType:
2406
+ title: PersonalIdentifierType
2407
+ type: string
2408
+ enum:
2409
+ - PASSPORT
2410
+ - NATIONAL_REGISTRATION
2411
+ - DRIVING_LICENSE
2412
+ - ALIEN_REGISTRATION
2413
+ - NATIONAL_ID_CARD
2414
+ - EMPLOYER_ID
2415
+ - TAX_ID_NUMBER
2416
+ - SENIOR_CITIZENS_CARD
2417
+ - MARRIAGE_CERTIFICATE
2418
+ - HEALTH_CARD
2419
+ - VOTERS_ID
2420
+ - UNITED_NATIONS
2421
+ - OTHER_ID
2422
+ description: Below are the allowed values for the enumeration.
2423
+
2424
+ - PASSPORT - A passport number is used as reference to a Party.
2425
+
2426
+ - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party.
2427
+
2428
+ - DRIVING_LICENSE - A driving license is used as reference to a Party.
2429
+
2430
+ - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party.
2431
+
2432
+ - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party.
2433
+
2434
+ - EMPLOYER_ID - A tax identification number is used as reference to a Party.
2435
+
2436
+ - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
2437
+
2438
+ - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
2439
+
2440
+ - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
2441
+
2442
+ - HEALTH_CARD - A health card number is used as reference to a Party.
2443
+
2444
+ - VOTERS_ID - A voter’s identification number is used as reference to a Party.
2445
+
2446
+ - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
2447
+
2448
+ - OTHER_ID - Any other type of identification type number is used as reference to a Party.
2449
+ QRCODE:
2450
+ title: QRCODE
2451
+ type: string
2452
+ minLength: 1
2453
+ maxLength: 64
2454
+ description: QR code used as a One Time Password.
2455
+ RefundReason:
2456
+ title: RefundReason
2457
+ type: string
2458
+ minLength: 1
2459
+ maxLength: 128
2460
+ description: Reason for the refund.
2461
+ TransactionInitiator:
2462
+ title: TransactionInitiator
2463
+ type: string
2464
+ enum:
2465
+ - PAYER
2466
+ - PAYEE
2467
+ description: Below are the allowed values for the enumeration.
2468
+
2469
+ - PAYER - Sender of funds is initiating the transaction. The account to send from is either owned by the Payer or is connected to the Payer in some way.
2470
+
2471
+ - PAYEE - Recipient of the funds is initiating the transaction by sending a transaction request. The Payer must approve the transaction, either automatically by a pre-generated OTP or by pre-approval of the Payee, or by manually approving in his or her own Device.
2472
+ TransactionInitiatorType:
2473
+ title: TransactionInitiatorType
2474
+ type: string
2475
+ enum:
2476
+ - CONSUMER
2477
+ - AGENT
2478
+ - BUSINESS
2479
+ - DEVICE
2480
+ description: Below are the allowed values for the enumeration.
2481
+
2482
+ - CONSUMER - Consumer is the initiator of the transaction.
2483
+
2484
+ - AGENT - Agent is the initiator of the transaction.
2485
+
2486
+ - BUSINESS - Business is the initiator of the transaction.
2487
+
2488
+ - DEVICE - Device is the initiator of the transaction.
2489
+ TransactionRequestState:
2490
+ title: TransactionRequestState
2491
+ type: string
2492
+ enum:
2493
+ - RECEIVED
2494
+ - PENDING
2495
+ - ACCEPTED
2496
+ - REJECTED
2497
+ description: Below are the allowed values for the enumeration.
2498
+
2499
+ - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
2500
+
2501
+ - PENDING - Payer FSP has sent the transaction request to the Payer.
2502
+
2503
+ - ACCEPTED - Payer has approved the transaction.
2504
+
2505
+ - REJECTED - Payer has rejected the transaction.
2506
+ TransactionScenario:
2507
+ title: TransactionScenario
2508
+ type: string
2509
+ enum:
2510
+ - DEPOSIT
2511
+ - WITHDRAWAL
2512
+ - TRANSFER
2513
+ - PAYMENT
2514
+ - REFUND
2515
+ description: Below are the allowed values for the enumeration.
2516
+
2517
+ - DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.
2518
+
2519
+ - WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.
2520
+
2521
+ - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
2522
+
2523
+ - PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.
2524
+
2525
+ - REFUND - Used for performing a refund of transaction.
2526
+ TransactionState:
2527
+ title: TransactionState
2528
+ type: string
2529
+ enum:
2530
+ - RECEIVED
2531
+ - PENDING
2532
+ - COMPLETED
2533
+ - REJECTED
2534
+ description: Below are the allowed values for the enumeration.
2535
+
2536
+ - RECEIVED - Payee FSP has received the transaction from the Payer FSP.
2537
+
2538
+ - PENDING - Payee FSP has validated the transaction.
2539
+
2540
+ - COMPLETED - Payee FSP has successfully performed the transaction.
2541
+
2542
+ - REJECTED - Payee FSP has failed to perform the transaction.
2543
+ TransactionSubScenario:
2544
+ title: TransactionSubScenario
2545
+ type: string
2546
+ pattern: ^[A-Z_]{1,32}$
2547
+ description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
2548
+ TransferState:
2549
+ title: TransferState
2550
+ type: string
2551
+ enum:
2552
+ - RECEIVED
2553
+ - RESERVED
2554
+ - COMMITTED
2555
+ - ABORTED
2556
+ description: Below are the allowed values for the enumeration.
2557
+
2558
+ - RECEIVED - Next ledger has received the transfer.
2559
+
2560
+ - RESERVED - Next ledger has reserved the transfer.
2561
+
2562
+ - COMMITTED - Next ledger has successfully performed the transfer.
2563
+
2564
+ - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
2565
+
2566
+ #Complex Types
2567
+ AuthenticationInfo:
2568
+ title: AuthenticationInfo
2569
+ type: object
2570
+ description: Data model for the complex type AuthenticationInfo.
2571
+ properties:
2572
+ authentication:
2573
+ allOf:
2574
+ - $ref: "#/components/schemas/AuthenticationType"
2575
+ - description: Type of authentication.
2576
+ - example: OTP
2577
+ authenticationValue:
2578
+ allOf:
2579
+ - $ref: "#/components/schemas/AuthenticationValue"
2580
+ - description: Authentication value.
2581
+ - example: 1234
2582
+ required:
2583
+ - authentication
2584
+ - authenticationValue
2585
+ AuthorizationsIDPutResponse:
2586
+ title: AuthorizationsIDPutResponse
2587
+ type: object
2588
+ description: The object sent in the PUT /authorizations/{ID} callback.
2589
+ properties:
2590
+ authenticationInfo:
2591
+ allOf:
2592
+ - $ref: "#/components/schemas/AuthenticationInfo"
2593
+ - description: OTP or QR Code if entered, otherwise empty.
2594
+ - example: OTP
2595
+ responseType:
2596
+ allOf:
2597
+ - $ref: "#/components/schemas/AuthorizationResponse"
2598
+ - description: Enum containing response information; if the customer entered the authentication value, rejected the transaction, or requested a resend of the authentication value.
2599
+ - example: ENTERED
2600
+ required:
2601
+ - responseType
2602
+ BulkQuotesIDPutResponse:
2603
+ title: BulkQuotesIDPutResponse
2604
+ type: object
2605
+ description: The object sent in the PUT /bulkQuotes/{ID} callback.
2606
+ properties:
2607
+ individualQuoteResults:
2608
+ type: array
2609
+ maxItems: 1000
2610
+ items:
2611
+ $ref: "#/components/schemas/IndividualQuoteResult"
2612
+ description: Fees for each individual transaction, if any of them are charged per transaction.
2613
+ expiration:
2614
+ allOf:
2615
+ - $ref: "#/components/schemas/DateTime"
2616
+ - description: Date and time until when the quotation is valid and can be honored when used in the subsequent transaction request.
2617
+ - example: "2016-05-24T08:38:08.699-04:00"
2618
+ extensionList:
2619
+ allOf:
2620
+ - $ref: "#/components/schemas/ExtensionList"
2621
+ - description: Optional extension, specific to deployment.
2622
+ required:
2623
+ - expiration
2624
+ BulkQuotesPostRequest:
2625
+ title: BulkQuotesPostRequest
2626
+ type: object
2627
+ description: The object sent in the POST /bulkQuotes request.
2628
+ properties:
2629
+ bulkQuoteId:
2630
+ allOf:
2631
+ - $ref: "#/components/schemas/CorrelationId"
2632
+ - description: Common ID between the FSPs for the bulk quote object, decided by the Payer FSP. The ID should be reused for resends of the same bulk quote. A new ID should be generated for each new bulk quote.
2633
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
2634
+ payer:
2635
+ allOf:
2636
+ - $ref: "#/components/schemas/Party"
2637
+ - description: Information about the Payer in the proposed financial transaction.
2638
+ geoCode:
2639
+ allOf:
2640
+ - $ref: "#/components/schemas/GeoCode"
2641
+ - description: Longitude and Latitude of the initiating Party. Can be used to detect fraud.
2642
+ expiration:
2643
+ allOf:
2644
+ - $ref: "#/components/schemas/DateTime"
2645
+ - description: Expiration is optional to let the Payee FSP know when a quote no longer needs to be returned.
2646
+ - example: "2016-05-24T08:38:08.699-04:00"
2647
+ individualQuotes:
2648
+ type: array
2649
+ minItems: 1
2650
+ maxItems: 1000
2651
+ items:
2652
+ $ref: "#/components/schemas/IndividualQuote"
2653
+ description: List of quotes elements.
2654
+ extensionList:
2655
+ allOf:
2656
+ - $ref: "#/components/schemas/ExtensionList"
2657
+ - description: Optional extension, specific to deployment.
2658
+ required:
2659
+ - bulkQuoteId
2660
+ - payer
2661
+ - individualQuotes
2662
+ BulkTransfersIDPutResponse:
2663
+ title: BulkTransfersIDPutResponse
2664
+ type: object
2665
+ description: The object sent in the PUT /bulkTransfers/{ID} callback.
2666
+ properties:
2667
+ completedTimestamp:
2668
+ allOf:
2669
+ - $ref: "#/components/schemas/DateTime"
2670
+ - description: Time and date when the bulk transaction was completed.
2671
+ - example: "2016-05-24T08:38:08.699-04:00"
2672
+ individualTransferResults:
2673
+ type: array
2674
+ maxItems: 1000
2675
+ items:
2676
+ $ref: "#/components/schemas/IndividualTransferResult"
2677
+ description: List of IndividualTransferResult elements.
2678
+ bulkTransferState:
2679
+ allOf:
2680
+ - $ref: "#/components/schemas/BulkTransferState"
2681
+ - description: The state of the bulk transfer.
2682
+ - example: RECEIVED
2683
+ extensionList:
2684
+ allOf:
2685
+ - $ref: "#/components/schemas/ExtensionList"
2686
+ - description: Optional extension, specific to deployment.
2687
+ required:
2688
+ - bulkTransferState
2689
+ BulkTransfersPostRequest:
2690
+ title: BulkTransfersPostRequest
2691
+ type: object
2692
+ description: The object sent in the POST /bulkTransfers request.
2693
+ properties:
2694
+ bulkTransferId:
2695
+ allOf:
2696
+ - $ref: "#/components/schemas/CorrelationId"
2697
+ - description: Common ID between the FSPs and the optional Switch for the bulk transfer object, decided by the Payer FSP. The ID should be reused for resends of the same bulk transfer. A new ID should be generated for each new bulk transfer.
2698
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
2699
+ bulkQuoteId:
2700
+ allOf:
2701
+ - $ref: "#/components/schemas/CorrelationId"
2702
+ - description: ID of the related bulk quote.
2703
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
2704
+ payerFsp:
2705
+ allOf:
2706
+ - $ref: "#/components/schemas/FspId"
2707
+ - description: Payer FSP identifier.
2708
+ - example: 5678
2709
+ payeeFsp:
2710
+ allOf:
2711
+ - $ref: "#/components/schemas/FspId"
2712
+ - description: Payee FSP identifier.
2713
+ - example: 1234
2714
+ individualTransfers:
2715
+ type: array
2716
+ minItems: 1
2717
+ maxItems: 1000
2718
+ items:
2719
+ $ref: "#/components/schemas/IndividualTransfer"
2720
+ description: List of IndividualTransfer elements.
2721
+ expiration:
2722
+ allOf:
2723
+ - $ref: "#/components/schemas/DateTime"
2724
+ - description: Expiration time of the transfers.
2725
+ - example: "2016-05-24T08:38:08.699-04:00"
2726
+ extensionList:
2727
+ allOf:
2728
+ - $ref: "#/components/schemas/ExtensionList"
2729
+ - description: Optional extension, specific to deployment.
2730
+ required:
2731
+ - bulkTransferId
2732
+ - bulkQuoteId
2733
+ - payerFsp
2734
+ - payeeFsp
2735
+ - individualTransfers
2736
+ - expiration
2737
+ ErrorInformation:
2738
+ title: ErrorInformation
2739
+ type: object
2740
+ description: Data model for the complex type ErrorInformation.
2741
+ properties:
2742
+ errorCode:
2743
+ allOf:
2744
+ - $ref: "#/components/schemas/ErrorCode"
2745
+ - description: Specific error number.
2746
+ - example: 5100
2747
+ errorDescription:
2748
+ allOf:
2749
+ - $ref: "#/components/schemas/ErrorDescription"
2750
+ - description: Error description string.
2751
+ - example: This is an error description.
2752
+ extensionList:
2753
+ $ref: "#/components/schemas/ExtensionList"
2754
+ required:
2755
+ - errorCode
2756
+ - errorDescription
2757
+ ErrorInformationObject:
2758
+ title: ErrorInformationObject
2759
+ type: object
2760
+ description: Data model for the complex type object that contains ErrorInformation.
2761
+ properties:
2762
+ errorInformation:
2763
+ $ref: "#/components/schemas/ErrorInformation"
2764
+ required:
2765
+ - errorInformation
2766
+ ErrorInformationResponse:
2767
+ title: ErrorInformationResponse
2768
+ type: object
2769
+ description: Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
2770
+ properties:
2771
+ errorInformation:
2772
+ $ref: "#/components/schemas/ErrorInformation"
2773
+ Extension:
2774
+ title: Extension
2775
+ type: object
2776
+ description: Data model for the complex type Extension.
2777
+ properties:
2778
+ key:
2779
+ allOf:
2780
+ - $ref: "#/components/schemas/ExtensionKey"
2781
+ - description: Extension key.
2782
+ value:
2783
+ allOf:
2784
+ - $ref: "#/components/schemas/ExtensionValue"
2785
+ - description: Extension value.
2786
+ required:
2787
+ - key
2788
+ - value
2789
+ ExtensionList:
2790
+ title: ExtensionList
2791
+ type: object
2792
+ description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2793
+ properties:
2794
+ extension:
2795
+ type: array
2796
+ items:
2797
+ $ref: "#/components/schemas/Extension"
2798
+ minItems: 1
2799
+ maxItems: 16
2800
+ description: Number of Extension elements.
2801
+ required:
2802
+ - extension
2803
+ GeoCode:
2804
+ title: GeoCode
2805
+ type: object
2806
+ description: Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
2807
+ properties:
2808
+ latitude:
2809
+ allOf:
2810
+ - $ref: "#/components/schemas/Latitude"
2811
+ - description: Latitude of the Party.
2812
+ - example: "+45.4215"
2813
+ longitude:
2814
+ allOf:
2815
+ - $ref: "#/components/schemas/Longitude"
2816
+ - description: Longitude of the Party.
2817
+ - example: "+75.6972"
2818
+ required:
2819
+ - latitude
2820
+ - longitude
2821
+ IndividualQuote:
2822
+ title: IndividualQuote
2823
+ type: object
2824
+ description: Data model for the complex type IndividualQuote.
2825
+ properties:
2826
+ quoteId:
2827
+ allOf:
2828
+ - $ref: "#/components/schemas/CorrelationId"
2829
+ - description: Identifies the quote message.
2830
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
2831
+ transactionId:
2832
+ allOf:
2833
+ - $ref: "#/components/schemas/CorrelationId"
2834
+ - description: Identifies the transaction message.
2835
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
2836
+ payee:
2837
+ allOf:
2838
+ - $ref: "#/components/schemas/Party"
2839
+ - description: Information about the Payee in the proposed financial transaction.
2840
+ amountType:
2841
+ allOf:
2842
+ - $ref: "#/components/schemas/AmountType"
2843
+ - description: SEND for sendAmount, RECEIVE for receiveAmount.
2844
+ - example: RECEIVE
2845
+ amount:
2846
+ allOf:
2847
+ - $ref: "#/components/schemas/Money"
2848
+ - description: Depending on amountType
2849
+ If SEND - The amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. The amount is updated by each participating entity in the transaction.
2850
+ If RECEIVE - The amount the Payee should receive, that is, the amount that should be sent to the receiver exclusive of any fees. The amount is not updated by any of the participating entities.
2851
+ fees:
2852
+ allOf:
2853
+ - $ref: "#/components/schemas/Money"
2854
+ - description: The fees in the transaction.
2855
+ The fees element should be empty if fees should be non-disclosed.
2856
+ The fees element should be non-empty if fees should be disclosed.
2857
+ transactionType:
2858
+ allOf:
2859
+ - $ref: "#/components/schemas/TransactionType"
2860
+ - description: Type of transaction that the quote is requested for.
2861
+ note:
2862
+ allOf:
2863
+ - $ref: "#/components/schemas/Note"
2864
+ - description: Memo that will be attached to the transaction.
2865
+ - example: Note sent to Payee.
2866
+ extensionList:
2867
+ allOf:
2868
+ - $ref: "#/components/schemas/ExtensionList"
2869
+ - description: Optional extension, specific to deployment.
2870
+ required:
2871
+ - quoteId
2872
+ - transactionId
2873
+ - payee
2874
+ - amountType
2875
+ - amount
2876
+ - transactionType
2877
+ IndividualQuoteResult:
2878
+ title: IndividualQuoteResult
2879
+ type: object
2880
+ description: Data model for the complex type IndividualQuoteResult.
2881
+ properties:
2882
+ quoteId:
2883
+ allOf:
2884
+ - $ref: "#/components/schemas/CorrelationId"
2885
+ - description: Identifies the quote message.
2886
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
2887
+ payee:
2888
+ allOf:
2889
+ - $ref: "#/components/schemas/Party"
2890
+ - description: Information about the Payee in the proposed financial transaction.
2891
+ transferAmount:
2892
+ allOf:
2893
+ - $ref: "#/components/schemas/Money"
2894
+ - description: The amount of money that the Payee FSP should receive.
2895
+ payeeReceiveAmount:
2896
+ allOf:
2897
+ - $ref: "#/components/schemas/Money"
2898
+ - description: The amount of Money that the Payee should receive in the end-to-end transaction. Optional as the Payee FSP might not want to disclose any optional Payee fees.
2899
+ payeeFspFee:
2900
+ allOf:
2901
+ - $ref: "#/components/schemas/Money"
2902
+ - description: Payee FSP’s part of the transaction fee.
2903
+ payeeFspCommission:
2904
+ allOf:
2905
+ - $ref: "#/components/schemas/Money"
2906
+ - description: Transaction commission from the Payee FSP.
2907
+ ilpPacket:
2908
+ allOf:
2909
+ - $ref: "#/components/schemas/IlpPacket"
2910
+ - description: The ILP Packet that must be attached to the transfer by the Payer.
2911
+ - example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
2912
+ condition:
2913
+ allOf:
2914
+ - $ref: "#/components/schemas/IlpCondition"
2915
+ - description: The condition that must be attached to the transfer by the Payer.
2916
+ - example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
2917
+ errorInformation:
2918
+ allOf:
2919
+ - $ref: "#/components/schemas/ErrorInformation"
2920
+ - description: Error code, category description. **Note:** receiveAmount, payeeFspFee, payeeFspCommission, expiration, ilpPacket, condition should not be set if errorInformation is set.
2921
+ extensionList:
2922
+ allOf:
2923
+ - $ref: "#/components/schemas/ExtensionList"
2924
+ - description: Optional extension, specific to deployment.
2925
+ required:
2926
+ - quoteId
2927
+ IndividualTransfer:
2928
+ title: IndividualTransfer
2929
+ type: object
2930
+ description: Data model for the complex type IndividualTransfer.
2931
+ properties:
2932
+ transferId:
2933
+ allOf:
2934
+ - $ref: "#/components/schemas/CorrelationId"
2935
+ - description: Identifies messages related to the same /transfers sequence.
2936
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
2937
+ transferAmount:
2938
+ allOf:
2939
+ - $ref: "#/components/schemas/Money"
2940
+ - description: Transaction amount to be sent.
2941
+ ilpPacket:
2942
+ allOf:
2943
+ - $ref: "#/components/schemas/IlpPacket"
2944
+ - description: ILP Packet containing the amount delivered to the Payee and the ILP Address of the Payee and any other end-to-end data.
2945
+ - example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
2946
+ condition:
2947
+ allOf:
2948
+ - $ref: "#/components/schemas/IlpCondition"
2949
+ - description: Condition that must be fulfilled to commit the transfer.
2950
+ - example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
2951
+ extensionList:
2952
+ allOf:
2953
+ - $ref: "#/components/schemas/ExtensionList"
2954
+ - description: Optional extension, specific to deployment.
2955
+ required:
2956
+ - transferId
2957
+ - transferAmount
2958
+ - ilpPacket
2959
+ - condition
2960
+ IndividualTransferResult:
2961
+ title: IndividualTransferResult
2962
+ type: object
2963
+ description: Data model for the complex type IndividualTransferResult.
2964
+ properties:
2965
+ transferId:
2966
+ allOf:
2967
+ - $ref: "#/components/schemas/CorrelationId"
2968
+ - description: Identifies messages related to the same /transfers sequence.
2969
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
2970
+ fulfilment:
2971
+ allOf:
2972
+ - $ref: "#/components/schemas/IlpFulfilment"
2973
+ - description: Fulfilment of the condition specified with the transaction. **Note:** Either fulfilment or errorInformation should be set, not both.
2974
+ - example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
2975
+ errorInformation:
2976
+ allOf:
2977
+ - $ref: "#/components/schemas/ErrorInformation"
2978
+ - description: If transfer is REJECTED, error information may be provided. **Note:** Either fulfilment or errorInformation should be set, not both.
2979
+ extensionList:
2980
+ allOf:
2981
+ - $ref: "#/components/schemas/ExtensionList"
2982
+ - description: Optional extension, specific to deployment.
2983
+ required:
2984
+ - transferId
2985
+ Money:
2986
+ title: Money
2987
+ type: object
2988
+ description: Data model for the complex type Money.
2989
+ properties:
2990
+ currency:
2991
+ allOf:
2992
+ - $ref: "#/components/schemas/Currency"
2993
+ - description: Currency of the amount.
2994
+ - example: USD
2995
+ amount:
2996
+ allOf:
2997
+ - $ref: "#/components/schemas/Amount"
2998
+ - description: Amount of Money.
2999
+ - example: "123.45"
3000
+ required:
3001
+ - currency
3002
+ - amount
3003
+ ParticipantsIDPutResponse:
3004
+ title: ParticipantsIDPutResponse
3005
+ type: object
3006
+ description: The object sent in the PUT /participants/{ID} callback.
3007
+ properties:
3008
+ partyList:
3009
+ type: array
3010
+ items:
3011
+ $ref: "#/components/schemas/PartyResult"
3012
+ minItems: 1
3013
+ maxItems: 10000
3014
+ description: List of PartyResult elements that were either created or failed to be created.
3015
+ currency:
3016
+ allOf:
3017
+ - $ref: "#/components/schemas/Currency"
3018
+ - description: Indicate that the provided Currency was set to be supported by each successfully added PartyIdInfo.
3019
+ - example: USD
3020
+ required:
3021
+ - partyList
3022
+ ParticipantsPostRequest:
3023
+ title: ParticipantsPostRequest
3024
+ type: object
3025
+ description: The object sent in the POST /participants request.
3026
+ properties:
3027
+ requestId:
3028
+ allOf:
3029
+ - $ref: "#/components/schemas/CorrelationId"
3030
+ - description: The ID of the request, decided by the client. Used for identification of the callback from the server.
3031
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
3032
+ partyList:
3033
+ type: array
3034
+ items:
3035
+ $ref: "#/components/schemas/PartyIdInfo"
3036
+ minItems: 1
3037
+ maxItems: 10000
3038
+ description: List of PartyIdInfo elements that the client would like to update or create FSP information about.
3039
+ currency:
3040
+ allOf:
3041
+ - $ref: "#/components/schemas/Currency"
3042
+ - description: Indicate that the provided Currency is supported by each PartyIdInfo in the list.
3043
+ - example: USD
3044
+ required:
3045
+ - requestId
3046
+ - partyList
3047
+ ParticipantsTypeIDPutResponse:
3048
+ title: ParticipantsTypeIDPutResponse
3049
+ type: object
3050
+ description: The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks.
3051
+ properties:
3052
+ fspId:
3053
+ allOf:
3054
+ - $ref: "#/components/schemas/FspId"
3055
+ - description: FSP Identifier that the Party belongs to.
3056
+ - example: 1234
3057
+ ParticipantsTypeIDSubIDPostRequest:
3058
+ title: ParticipantsTypeIDSubIDPostRequest
3059
+ type: object
3060
+ description: The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. An additional optional ExtensionList element has been added as part of v1.1 changes.
3061
+ properties:
3062
+ fspId:
3063
+ allOf:
3064
+ - $ref: "#/components/schemas/FspId"
3065
+ - description: FSP Identifier that the Party belongs to.
3066
+ - example: 1234
3067
+ currency:
3068
+ allOf:
3069
+ - $ref: "#/components/schemas/Currency"
3070
+ - description: Indicate that the provided Currency is supported by the Party.
3071
+ - example: USD
3072
+ extensionList:
3073
+ allOf:
3074
+ - $ref: "#/components/schemas/ExtensionList"
3075
+ - description: Optional extension, specific to deployment.
3076
+ required:
3077
+ - fspId
3078
+ PartiesTypeIDPutResponse:
3079
+ title: PartiesTypeIDPutResponse
3080
+ type: object
3081
+ description: The object sent in the PUT /parties/{Type}/{ID} callback.
3082
+ properties:
3083
+ party:
3084
+ allOf:
3085
+ - $ref: "#/components/schemas/Party"
3086
+ - description: Information regarding the requested Party.
3087
+ required:
3088
+ - party
3089
+ Party:
3090
+ title: Party
3091
+ type: object
3092
+ description: Data model for the complex type Party.
3093
+ properties:
3094
+ partyIdInfo:
3095
+ allOf:
3096
+ - $ref: "#/components/schemas/PartyIdInfo"
3097
+ - description: Party Id type, id, sub ID or type, and FSP Id.
3098
+ merchantClassificationCode:
3099
+ allOf:
3100
+ - $ref: "#/components/schemas/MerchantClassificationCode"
3101
+ - description: Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments.
3102
+ - example: 4321
3103
+ name:
3104
+ allOf:
3105
+ - $ref: "#/components/schemas/PartyName"
3106
+ - description: Display name of the Party, could be a real name or a nick name.
3107
+ - example: Henrik Karlsson
3108
+ personalInfo:
3109
+ allOf:
3110
+ - $ref: "#/components/schemas/PartyPersonalInfo"
3111
+ - description: Personal information used to verify identity of Party such as first, middle, last name and date of birth.
3112
+ required:
3113
+ - partyIdInfo
3114
+ PartyComplexName:
3115
+ title: PartyComplexName
3116
+ type: object
3117
+ description: Data model for the complex type PartyComplexName.
3118
+ properties:
3119
+ firstName:
3120
+ allOf:
3121
+ - $ref: "#/components/schemas/FirstName"
3122
+ - description: Party’s first name.
3123
+ - example: Henrik
3124
+ middleName:
3125
+ allOf:
3126
+ - $ref: "#/components/schemas/MiddleName"
3127
+ - description: Party’s middle name.
3128
+ - example: Johannes
3129
+ lastName:
3130
+ allOf:
3131
+ - $ref: "#/components/schemas/LastName"
3132
+ - description: Party’s last name.
3133
+ - example: Karlsson
3134
+ PartyIdInfo:
3135
+ title: PartyIdInfo
3136
+ type: object
3137
+ description: Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
3138
+ properties:
3139
+ partyIdType:
3140
+ allOf:
3141
+ - $ref: "#/components/schemas/PartyIdType"
3142
+ - description: Type of the identifier.
3143
+ - example: PERSONAL_ID
3144
+ partyIdentifier:
3145
+ allOf:
3146
+ - $ref: "#/components/schemas/PartyIdentifier"
3147
+ - description: An identifier for the Party.
3148
+ - example: 16135551212
3149
+ partySubIdOrType:
3150
+ allOf:
3151
+ - $ref: "#/components/schemas/PartySubIdOrType"
3152
+ - description: A sub-identifier or sub-type for the Party.
3153
+ - example: DRIVING_LICENSE
3154
+ fspId:
3155
+ allOf:
3156
+ - $ref: "#/components/schemas/FspId"
3157
+ - description: FSP ID (if known).
3158
+ - example: 1234
3159
+ extensionList:
3160
+ allOf:
3161
+ - $ref: "#/components/schemas/ExtensionList"
3162
+ - description: Optional extension, specific to deployment.
3163
+ required:
3164
+ - partyIdType
3165
+ - partyIdentifier
3166
+ PartyPersonalInfo:
3167
+ title: PartyPersonalInfo
3168
+ type: object
3169
+ description: Data model for the complex type PartyPersonalInfo.
3170
+ properties:
3171
+ complexName:
3172
+ allOf:
3173
+ - $ref: "#/components/schemas/PartyComplexName"
3174
+ - description: First, middle and last name for the Party.
3175
+ dateOfBirth:
3176
+ allOf:
3177
+ - $ref: "#/components/schemas/DateOfBirth"
3178
+ - description: Date of birth for the Party.
3179
+ - example: "1966-06-16"
3180
+ PartyResult:
3181
+ title: PartyResult
3182
+ type: object
3183
+ description: Data model for the complex type PartyResult.
3184
+ properties:
3185
+ partyId:
3186
+ allOf:
3187
+ - $ref: "#/components/schemas/PartyIdInfo"
3188
+ - description: Party Id type, id, sub ID or type, and FSP Id.
3189
+ errorInformation:
3190
+ allOf:
3191
+ - $ref: "#/components/schemas/ErrorInformation"
3192
+ - description: If the Party failed to be added, error information should be provided. Otherwise, this parameter should be empty to indicate success.
3193
+ required:
3194
+ - partyId
3195
+ QuotesIDPutResponse:
3196
+ title: QuotesIDPutResponse
3197
+ type: object
3198
+ description: The object sent in the PUT /quotes/{ID} callback.
3199
+ properties:
3200
+ transferAmount:
3201
+ allOf:
3202
+ - $ref: "#/components/schemas/Money"
3203
+ - description: The amount of money that the Payee FSP should receive.
3204
+ payeeReceiveAmount:
3205
+ allOf:
3206
+ - $ref: "#/components/schemas/Money"
3207
+ - description: The amount of Money that the Payee should receive in the end-to-end transaction. Optional as the Payee FSP might not want to disclose any optional Payee fees.
3208
+ payeeFspFee:
3209
+ allOf:
3210
+ - $ref: "#/components/schemas/Money"
3211
+ - description: Payee FSP’s part of the transaction fee.
3212
+ payeeFspCommission:
3213
+ allOf:
3214
+ - $ref: "#/components/schemas/Money"
3215
+ - description: Transaction commission from the Payee FSP.
3216
+ expiration:
3217
+ allOf:
3218
+ - $ref: "#/components/schemas/DateTime"
3219
+ - description: Date and time until when the quotation is valid and can be honored when used in the subsequent transaction.
3220
+ - example: "2016-05-24T08:38:08.699-04:00"
3221
+ geoCode:
3222
+ allOf:
3223
+ - $ref: "#/components/schemas/GeoCode"
3224
+ - description: Longitude and Latitude of the Payee. Can be used to detect fraud.
3225
+ ilpPacket:
3226
+ allOf:
3227
+ - $ref: "#/components/schemas/IlpPacket"
3228
+ - description: The ILP Packet that must be attached to the transfer by the Payer.
3229
+ - example: “AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA”
3230
+ condition:
3231
+ allOf:
3232
+ - $ref: "#/components/schemas/IlpCondition"
3233
+ - description: The condition that must be attached to the transfer by the Payer.
3234
+ - example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
3235
+ extensionList:
3236
+ allOf:
3237
+ - $ref: "#/components/schemas/ExtensionList"
3238
+ - description: Optional extension, specific to deployment.
3239
+ required:
3240
+ - transferAmount
3241
+ - expiration
3242
+ - ilpPacket
3243
+ - condition
3244
+ QuotesPostRequest:
3245
+ title: QuotesPostRequest
3246
+ type: object
3247
+ description: The object sent in the POST /quotes request.
3248
+ properties:
3249
+ quoteId:
3250
+ allOf:
3251
+ - $ref: "#/components/schemas/CorrelationId"
3252
+ - description: Common ID between the FSPs for the quote object, decided by the Payer FSP. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction.
3253
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
3254
+ transactionId:
3255
+ allOf:
3256
+ - $ref: "#/components/schemas/CorrelationId"
3257
+ - description: Common ID (decided by the Payer FSP) between the FSPs for the future transaction object. The actual transaction will be created as part of a successful transfer process. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction.
3258
+ - example: a8323bc6-c228-4df2-ae82-e5a997baf899
3259
+ transactionRequestId:
3260
+ allOf:
3261
+ - $ref: "#/components/schemas/CorrelationId"
3262
+ - description: Identifies an optional previously-sent transaction request.
3263
+ - example: a8323bc6-c228-4df2-ae82-e5a997baf890
3264
+ payee:
3265
+ allOf:
3266
+ - $ref: "#/components/schemas/Party"
3267
+ - description: Information about the Payee in the proposed financial transaction.
3268
+ payer:
3269
+ allOf:
3270
+ - $ref: "#/components/schemas/Party"
3271
+ - description: Information about the Payer in the proposed financial transaction.
3272
+ amountType:
3273
+ allOf:
3274
+ - $ref: "#/components/schemas/AmountType"
3275
+ - description: SEND for send amount, RECEIVE for receive amount.
3276
+ - example: SEND
3277
+ amount:
3278
+ allOf:
3279
+ - $ref: "#/components/schemas/Money"
3280
+ - description: Depending on amountType -
3281
+ If SEND - The amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. The amount is updated by each participating entity in the transaction.
3282
+ If RECEIVE - The amount the Payee should receive, that is, the amount that should be sent to the receiver exclusive any fees. The amount is not updated by any of the participating entities.
3283
+ fees:
3284
+ allOf:
3285
+ - $ref: "#/components/schemas/Money"
3286
+ - description: The fees in the transaction.
3287
+ The fees element should be empty if fees should be non-disclosed.
3288
+ The fees element should be non-empty if fees should be disclosed.
3289
+ transactionType:
3290
+ allOf:
3291
+ - $ref: "#/components/schemas/TransactionType"
3292
+ - description: Type of transaction for which the quote is requested.
3293
+ geoCode:
3294
+ allOf:
3295
+ - $ref: "#/components/schemas/GeoCode"
3296
+ - description: Longitude and Latitude of the initiating Party. Can be used to detect fraud.
3297
+ note:
3298
+ allOf:
3299
+ - $ref: "#/components/schemas/Note"
3300
+ - description: A memo that will be attached to the transaction.
3301
+ - example: Free-text memo.
3302
+ expiration:
3303
+ allOf:
3304
+ - $ref: "#/components/schemas/DateTime"
3305
+ - description: Expiration is optional. It can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, and Merchant to know that their request has a time limit.
3306
+ - example: "2016-05-24T08:38:08.699-04:00"
3307
+ extensionList:
3308
+ allOf:
3309
+ - $ref: "#/components/schemas/ExtensionList"
3310
+ - description: Optional extension, specific to deployment.
3311
+ required:
3312
+ - quoteId
3313
+ - transactionId
3314
+ - payee
3315
+ - payer
3316
+ - amountType
3317
+ - amount
3318
+ - transactionType
3319
+ Refund:
3320
+ title: Refund
3321
+ type: object
3322
+ description: Data model for the complex type Refund.
3323
+ properties:
3324
+ originalTransactionId:
3325
+ allOf:
3326
+ - $ref: "#/components/schemas/CorrelationId"
3327
+ - description: Reference to the original transaction ID that is requested to be refunded.
3328
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
3329
+ refundReason:
3330
+ allOf:
3331
+ - $ref: "#/components/schemas/RefundReason"
3332
+ - description: Free text indicating the reason for the refund.
3333
+ - example: Free text indicating reason for the refund.
3334
+ required:
3335
+ - originalTransactionId
3336
+ TransactionRequestsIDPutResponse:
3337
+ title: TransactionRequestsIDPutResponse
3338
+ type: object
3339
+ description: The object sent in the PUT /transactionRequests/{ID} callback.
3340
+ properties:
3341
+ transactionId:
3342
+ allOf:
3343
+ - $ref: "#/components/schemas/CorrelationId"
3344
+ - description: Identifies a related transaction (if a transaction has been created).
3345
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
3346
+ transactionRequestState:
3347
+ allOf:
3348
+ - $ref: "#/components/schemas/TransactionRequestState"
3349
+ - description: State of the transaction request.
3350
+ - example: RECEIVED
3351
+ extensionList:
3352
+ allOf:
3353
+ - $ref: "#/components/schemas/ExtensionList"
3354
+ - description: Optional extension, specific to deployment.
3355
+ required:
3356
+ - transactionRequestState
3357
+ TransactionRequestsPostRequest:
3358
+ title: TransactionRequestsPostRequest
3359
+ type: object
3360
+ description: The object sent in the POST /transactionRequests request.
3361
+ properties:
3362
+ transactionRequestId:
3363
+ allOf:
3364
+ - $ref: "#/components/schemas/CorrelationId"
3365
+ - description: Common ID between the FSPs for the transaction request object, decided by the Payee FSP. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request.
3366
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
3367
+ payee:
3368
+ allOf:
3369
+ - $ref: "#/components/schemas/Party"
3370
+ - description: Information about the Payee in the proposed financial transaction.
3371
+ payer:
3372
+ allOf:
3373
+ - $ref: "#/components/schemas/PartyIdInfo"
3374
+ - description: Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.
3375
+ amount:
3376
+ allOf:
3377
+ - $ref: "#/components/schemas/Money"
3378
+ - description: Requested amount to be transferred from the Payer to Payee.
3379
+ transactionType:
3380
+ allOf:
3381
+ - $ref: "#/components/schemas/TransactionType"
3382
+ - description: Type of transaction.
3383
+ note:
3384
+ allOf:
3385
+ - $ref: "#/components/schemas/Note"
3386
+ - description: Reason for the transaction request, intended to the Payer.
3387
+ - example: Free-text memo.
3388
+ geoCode:
3389
+ allOf:
3390
+ - $ref: "#/components/schemas/GeoCode"
3391
+ - description: Longitude and Latitude of the initiating Party. Can be used to detect fraud.
3392
+ authenticationType:
3393
+ allOf:
3394
+ - $ref: "#/components/schemas/AuthenticationType"
3395
+ - description: OTP or QR Code, otherwise empty.
3396
+ - example: OTP
3397
+ expiration:
3398
+ allOf:
3399
+ - $ref: "#/components/schemas/DateTime"
3400
+ - description: Can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, Merchant to know that their request has a time limit.
3401
+ - example: "2016-05-24T08:38:08.699-04:00"
3402
+ extensionList:
3403
+ allOf:
3404
+ - $ref: "#/components/schemas/ExtensionList"
3405
+ - description: Optional extension, specific to deployment.
3406
+ required:
3407
+ - transactionRequestId
3408
+ - payee
3409
+ - payer
3410
+ - amount
3411
+ - transactionType
3412
+ TransactionsIDPutResponse:
3413
+ title: TransactionsIDPutResponse
3414
+ type: object
3415
+ description: The object sent in the PUT /transactions/{ID} callback.
3416
+ properties:
3417
+ completedTimestamp:
3418
+ allOf:
3419
+ - $ref: "#/components/schemas/DateTime"
3420
+ - description: Time and date when the transaction was completed.
3421
+ - example: "2016-05-24T08:38:08.699-04:00"
3422
+ transactionState:
3423
+ allOf:
3424
+ - $ref: "#/components/schemas/TransactionState"
3425
+ - description: State of the transaction.
3426
+ - example: RECEIVED
3427
+ code:
3428
+ allOf:
3429
+ - $ref: "#/components/schemas/Code"
3430
+ - description: Optional redemption information provided to Payer after transaction has been completed.
3431
+ - example: Test-Code
3432
+ extensionList:
3433
+ allOf:
3434
+ - $ref: "#/components/schemas/ExtensionList"
3435
+ - description: Optional extension, specific to deployment.
3436
+ required:
3437
+ - transactionState
3438
+ TransactionType:
3439
+ title: TransactionType
3440
+ type: object
3441
+ description: Data model for the complex type TransactionType.
3442
+ properties:
3443
+ scenario:
3444
+ allOf:
3445
+ - $ref: "#/components/schemas/TransactionScenario"
3446
+ - description: Deposit, withdrawal, refund, …
3447
+ - example: DEPOSIT
3448
+ subScenario:
3449
+ allOf:
3450
+ - $ref: "#/components/schemas/TransactionSubScenario"
3451
+ - description: Possible sub-scenario, defined locally within the scheme.
3452
+ - example: Locally defined sub-scenario.
3453
+ initiator:
3454
+ allOf:
3455
+ - $ref: "#/components/schemas/TransactionInitiator"
3456
+ - description: Who is initiating the transaction - Payer or Payee.
3457
+ - example: PAYEE
3458
+ initiatorType:
3459
+ allOf:
3460
+ - $ref: "#/components/schemas/TransactionInitiatorType"
3461
+ - description: Consumer, agent, business, …
3462
+ - example: CONSUMER
3463
+ refundInfo:
3464
+ allOf:
3465
+ - $ref: "#/components/schemas/Refund"
3466
+ - description: Extra information specific to a refund scenario. Should only be populated if scenario is REFUND.
3467
+ balanceOfPayments:
3468
+ allOf:
3469
+ - $ref: "#/components/schemas/BalanceOfPayments"
3470
+ - description: Balance of Payments code.
3471
+ - example: 123
3472
+ required:
3473
+ - scenario
3474
+ - initiator
3475
+ - initiatorType
3476
+ TransfersIDPatchResponse:
3477
+ title: TransfersIDPatchResponse
3478
+ type: object
3479
+ description: PATCH /transfers/{ID} object
3480
+ properties:
3481
+ completedTimestamp:
3482
+ allOf:
3483
+ - $ref: "#/components/schemas/DateTime"
3484
+ - description: Time and date when the transaction was completed.
3485
+ - example: "2020-05-19T08:38:08.699-04:00"
3486
+ transferState:
3487
+ allOf:
3488
+ - $ref: "#/components/schemas/TransferState"
3489
+ - description: State of the transfer.
3490
+ - example: RESERVED
3491
+ extensionList:
3492
+ allOf:
3493
+ - $ref: "#/components/schemas/ExtensionList"
3494
+ - description: Optional extension, specific to deployment.
3495
+ required:
3496
+ - completedTimestamp
3497
+ - transferState
3498
+ TransfersIDPutResponse:
3499
+ title: TransfersIDPutResponse
3500
+ type: object
3501
+ description: The object sent in the PUT /transfers/{ID} callback.
3502
+ properties:
3503
+ fulfilment:
3504
+ allOf:
3505
+ - $ref: "#/components/schemas/IlpFulfilment"
3506
+ - description: Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully.
3507
+ - example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
3508
+ completedTimestamp:
3509
+ allOf:
3510
+ - $ref: "#/components/schemas/DateTime"
3511
+ - description: Time and date when the transaction was completed.
3512
+ - example: "2016-05-24T08:38:08.699-04:00"
3513
+ transferState:
3514
+ allOf:
3515
+ - $ref: "#/components/schemas/TransferState"
3516
+ - description: State of the transfer.
3517
+ - example: COMMITTED
3518
+ extensionList:
3519
+ allOf:
3520
+ - $ref: "#/components/schemas/ExtensionList"
3521
+ - description: Optional extension, specific to deployment.
3522
+ required:
3523
+ - transferState
3524
+ TransfersPostRequest:
3525
+ title: TransfersPostRequest
3526
+ type: object
3527
+ description: The object sent in the POST /transfers request.
3528
+ properties:
3529
+ transferId:
3530
+ allOf:
3531
+ - $ref: "#/components/schemas/CorrelationId"
3532
+ - description: The common ID between the FSPs and the optional Switch for the transfer object, decided by the Payer FSP. The ID should be reused for resends of the same transfer. A new ID should be generated for each new transfer.
3533
+ - example: b51ec534-ee48-4575-b6a9-ead2955b8069
3534
+ payeeFsp:
3535
+ allOf:
3536
+ - $ref: "#/components/schemas/FspId"
3537
+ - description: Payee FSP in the proposed financial transaction.
3538
+ - example: 1234
3539
+ payerFsp:
3540
+ allOf:
3541
+ - $ref: "#/components/schemas/FspId"
3542
+ - description: Payer FSP in the proposed financial transaction.
3543
+ - example: 5678
3544
+ amount:
3545
+ allOf:
3546
+ - $ref: "#/components/schemas/Money"
3547
+ - description: The transfer amount to be sent.
3548
+ ilpPacket:
3549
+ allOf:
3550
+ - $ref: "#/components/schemas/IlpPacket"
3551
+ - description: The ILP Packet containing the amount delivered to the Payee and the ILP Address of the Payee and any other end-to-end data.
3552
+ - example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3553
+ condition:
3554
+ allOf:
3555
+ - $ref: "#/components/schemas/IlpCondition"
3556
+ - description: The condition that must be fulfilled to commit the transfer.
3557
+ - example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
3558
+ expiration:
3559
+ allOf:
3560
+ - $ref: "#/components/schemas/DateTime"
3561
+ - description: Expiration can be set to get a quick failure expiration of the transfer. The transfer should be rolled back if no fulfilment is delivered before this time.
3562
+ - example: "2016-05-24T08:38:08.699-04:00"
3563
+ extensionList:
3564
+ allOf:
3565
+ - $ref: "#/components/schemas/ExtensionList"
3566
+ - description: Optional extension, specific to deployment.
3567
+ required:
3568
+ - transferId
3569
+ - payeeFsp
3570
+ - payerFsp
3571
+ - amount
3572
+ - ilpPacket
3573
+ - condition
3574
+ - expiration
3575
+
3576
+ responses:
3577
+ "200":
3578
+ description: OK
3579
+ "202":
3580
+ description: Accepted
3581
+ "400":
3582
+ description: Bad Request
3583
+ content:
3584
+ application/json:
3585
+ schema:
3586
+ $ref: "#/components/schemas/ErrorInformationResponse"
3587
+ headers:
3588
+ Content-Length:
3589
+ $ref: "#/components/parameters/Content-Length"
3590
+ Content-Type:
3591
+ $ref: "#/components/parameters/Content-Type"
3592
+ "401":
3593
+ description: Unauthorized
3594
+ content:
3595
+ application/json:
3596
+ schema:
3597
+ $ref: "#/components/schemas/ErrorInformationResponse"
3598
+ headers:
3599
+ Content-Length:
3600
+ $ref: "#/components/parameters/Content-Length"
3601
+ Content-Type:
3602
+ $ref: "#/components/parameters/Content-Type"
3603
+ "403":
3604
+ description: Forbidden
3605
+ content:
3606
+ application/json:
3607
+ schema:
3608
+ $ref: "#/components/schemas/ErrorInformationResponse"
3609
+ headers:
3610
+ Content-Length:
3611
+ $ref: "#/components/parameters/Content-Length"
3612
+ Content-Type:
3613
+ $ref: "#/components/parameters/Content-Type"
3614
+ "404":
3615
+ description: Not Found
3616
+ content:
3617
+ application/json:
3618
+ schema:
3619
+ $ref: "#/components/schemas/ErrorInformationResponse"
3620
+ headers:
3621
+ Content-Length:
3622
+ $ref: "#/components/parameters/Content-Length"
3623
+ Content-Type:
3624
+ $ref: "#/components/parameters/Content-Type"
3625
+ "405":
3626
+ description: Method Not Allowed
3627
+ content:
3628
+ application/json:
3629
+ schema:
3630
+ $ref: "#/components/schemas/ErrorInformationResponse"
3631
+ headers:
3632
+ Content-Length:
3633
+ $ref: "#/components/parameters/Content-Length"
3634
+ Content-Type:
3635
+ $ref: "#/components/parameters/Content-Type"
3636
+ "406":
3637
+ description: Not Acceptable
3638
+ content:
3639
+ application/json:
3640
+ schema:
3641
+ $ref: "#/components/schemas/ErrorInformationResponse"
3642
+ headers:
3643
+ Content-Length:
3644
+ $ref: "#/components/parameters/Content-Length"
3645
+ Content-Type:
3646
+ $ref: "#/components/parameters/Content-Type"
3647
+ "501":
3648
+ description: Not Implemented
3649
+ content:
3650
+ application/json:
3651
+ schema:
3652
+ $ref: "#/components/schemas/ErrorInformationResponse"
3653
+ headers:
3654
+ Content-Length:
3655
+ $ref: "#/components/parameters/Content-Length"
3656
+ Content-Type:
3657
+ $ref: "#/components/parameters/Content-Type"
3658
+ "503":
3659
+ description: Service Unavailable
3660
+ content:
3661
+ application/json:
3662
+ schema:
3663
+ $ref: "#/components/schemas/ErrorInformationResponse"
3664
+ headers:
3665
+ Content-Length:
3666
+ $ref: "#/components/parameters/Content-Length"
3667
+ Content-Type:
3668
+ $ref: "#/components/parameters/Content-Type"
3669
+
3670
+ parameters:
3671
+ #Header parameters
3672
+ Accept:
3673
+ name: Accept
3674
+ in: header
3675
+ required: true
3676
+ schema:
3677
+ type: string
3678
+ description: The `Accept` header field indicates the version of the API the client would like the server to use.
3679
+ Content-Length:
3680
+ name: Content-Length
3681
+ in: header
3682
+ required: false
3683
+ schema:
3684
+ type: integer
3685
+ description:
3686
+ The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
3687
+
3688
+
3689
+ **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
3690
+ Content-Type:
3691
+ name: Content-Type
3692
+ in: header
3693
+ schema:
3694
+ type: string
3695
+ required: true
3696
+ description: The `Content-Type` header indicates the specific version of the API used to send the payload body.
3697
+ Date:
3698
+ name: Date
3699
+ in: header
3700
+ schema:
3701
+ type: string
3702
+ required: true
3703
+ description: The `Date` header field indicates the date when the request was sent.
3704
+ X-Forwarded-For:
3705
+ name: X-Forwarded-For
3706
+ in: header
3707
+ schema:
3708
+ type: string
3709
+ required: false
3710
+ description:
3711
+ The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
3712
+
3713
+
3714
+ **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
3715
+ FSPIOP-Source:
3716
+ name: FSPIOP-Source
3717
+ in: header
3718
+ schema:
3719
+ type: string
3720
+ required: true
3721
+ description: The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`).
3722
+ FSPIOP-Destination:
3723
+ name: FSPIOP-Destination
3724
+ in: header
3725
+ schema:
3726
+ type: string
3727
+ required: false
3728
+ 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.
3729
+ FSPIOP-Encryption:
3730
+ name: FSPIOP-Encryption
3731
+ in: header
3732
+ schema:
3733
+ type: string
3734
+ required: false
3735
+ description: The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.
3736
+ FSPIOP-Signature:
3737
+ name: FSPIOP-Signature
3738
+ in: header
3739
+ schema:
3740
+ type: string
3741
+ required: false
3742
+ description: The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.
3743
+ FSPIOP-URI:
3744
+ name: FSPIOP-URI
3745
+ in: header
3746
+ schema:
3747
+ type: string
3748
+ required: false
3749
+ 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).
3750
+ FSPIOP-HTTP-Method:
3751
+ name: FSPIOP-HTTP-Method
3752
+ in: header
3753
+ schema:
3754
+ type: string
3755
+ required: false
3756
+ 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).
3757
+ #Path parameters
3758
+ ID:
3759
+ name: ID
3760
+ in: path
3761
+ required: true
3762
+ schema:
3763
+ type: string
3764
+ description: The identifier value.
3765
+ Type:
3766
+ name: Type
3767
+ in: path
3768
+ required: true
3769
+ schema:
3770
+ type: string
3771
+ description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
3772
+ SubId:
3773
+ name: SubId
3774
+ in: path
3775
+ required: true
3776
+ schema:
3777
+ type: string
3778
+ description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.