Profee
/
profee-com-external-precalcs-api
mirror of https://github.com/profee-com/external-precalcs-api.git
4
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc update

pull/1/head
bvn13 2021-08-12 15:32:05 +03:00
parent f8c397a985
commit 0993d10d95
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
precalc-api.json
View File

@ -1 +1 @@
{"openapi":"3.0.1","info":{"title":"Profee Payment calculation API","description":"<h1>Welcome to the Profee Payment calculation API documentation.</h1>\n<p>\n This is a living document to be updated regularly with new functionality. To address questions\n to our developers please contact: <a href=\"mailto:support@profeelab.net\">support@profeelab.net</a>\n</p>","license":{"name":"Profee","url":"http://profee.com"},"version":"v0.0.1"},"servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"paths":{"/api/calc":{"post":{"tags":["Payments"],"summary":"Payment calculation","description":"Perform payment calculation","operationId":"calculate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseContainerDto"}}}}}}}},"components":{"schemas":{"RequestDto":{"required":["fromCurrency","merchantId","toCurrency"],"type":"object","properties":{"merchantId":{"type":"string","description":"Merchant ID"},"fromCurrency":{"type":"string","description":"Source currency (ISO code)"},"fromAmount":{"type":"number","description":"Source amount"},"toCurrency":{"type":"string","description":"Destination currency (ISO code)"},"toAmount":{"type":"number","description":"Destination amount"}},"description":"Request for payment calculation (either 'fromAmount' or 'toAmount' must be specified)"},"ResponseContainerDto":{"required":["message","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/ResponseDto"},"status":{"type":"string","description":"Status of performed operation","enum":["OK","ERROR"]},"message":{"type":"string","description":"Error message when occurred, 'OK' otherwise"}},"description":"Response container"},"ResponseDto":{"type":"object","properties":{"precalcId":{"type":"string","description":"Calcution ID"},"fromCurrency":{"type":"string","description":"Source currency"},"fromAmount":{"type":"number","description":"Source amount"},"toCurrency":{"type":"string","description":"Destination currency"},"toAmount":{"type":"number","description":"Destination amount"},"feeCurrency":{"type":"string","description":"Fee currency"},"feeAmount":{"type":"number","description":"Fee amount"},"rateFromCurrency":{"type":"string","description":"Rate source currency"},"rateToCurrency":{"type":"string","description":"Rate destination currency"},"rateAmount":{"type":"number","description":"Currency rate amount"}},"description":"Payment calculation result"}}}}
{"openapi":"3.0.1","info":{"title":"Profee Payment calculation API","description":"<h1>Welcome to the Profee Payment calculation API documentation.</h1>\n<p>\n This is a living document to be updated regularly with new functionality. To address questions\n to our developers please contact: <a href=\"mailto:support@profeelab.net\">support@profeelab.net</a>\n</p>","license":{"name":"Profee","url":"http://profee.com"},"version":"v1.0"},"servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"paths":{"/api/calc":{"post":{"tags":["Payments"],"summary":"Payment calculation","description":"Perform payment calculation","operationId":"calculate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseContainerDto"}}}}}}}},"components":{"schemas":{"RequestDto":{"required":["fromCurrency","merchantId","toCurrency"],"type":"object","properties":{"merchantId":{"type":"string","description":"Merchant ID"},"fromCurrency":{"type":"string","description":"Source currency (ISO code)"},"fromAmount":{"type":"number","description":"Source amount"},"toCurrency":{"type":"string","description":"Destination currency (ISO code)"},"toAmount":{"type":"number","description":"Destination amount"}},"description":"Request for payment calculation (either 'fromAmount' or 'toAmount' must be specified)"},"ResponseContainerDto":{"required":["message","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/ResponseDto"},"status":{"type":"string","description":"Status of performed operation","enum":["OK","ERROR"]},"message":{"type":"string","description":"Error message when occurred, 'OK' otherwise"}},"description":"Response container"},"ResponseDto":{"type":"object","properties":{"precalcId":{"type":"string","description":"Calcution ID"},"fromCurrency":{"type":"string","description":"Source currency"},"fromAmount":{"type":"number","description":"Source amount"},"toCurrency":{"type":"string","description":"Destination currency"},"toAmount":{"type":"number","description":"Destination amount"},"feeCurrency":{"type":"string","description":"Fee currency"},"feeAmount":{"type":"number","description":"Fee amount"},"rateFromCurrency":{"type":"string","description":"Rate source currency"},"rateToCurrency":{"type":"string","description":"Rate destination currency"},"rateAmount":{"type":"number","description":"Currency rate amount"}},"description":"Payment calculation result"}}}}