profee-waas-pf-waas-api/async-api/site/index.html

67 lines
31 KiB
HTML
Raw Normal View History

2022-04-08 10:49:31 +03:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
2022-04-08 11:56:07 +03:00
<title>Profee WAAS Notificatioins API 1.0 documentation</title>
2022-04-08 10:49:31 +03:00
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="css/global.min.css" rel="stylesheet">
<link href="css/asyncapi.min.css" rel="stylesheet">
</head>
<body>
2022-04-08 11:56:07 +03:00
<div id="root"><section class="aui-root"><div class="container:xl relative md:flex bg-white leading-normal"><div class="burger-menu rounded-full h-16 w-16 bg-white fixed bottom-16 right-8 flex items-center justify-center z-30 cursor-pointer shadow-md bg-teal-500" data-lol="false"><svg viewBox="0 0 100 70" width="40" height="30" class="fill-current text-gray-200"><rect width="100" height="10"></rect><rect y="30" width="100" height="10"></rect><rect y="60" width="100" height="10"></rect></svg></div><div class="hidden sidebar relative w-64 max-h-screen h-full bg-gray-200 shadow z-20"><div class=" block fixed max-h-screen h-full font-sans px-4 pt-8 pb-16 overflow-y-auto bg-gray-200"><div class="sidebar--content"><div><h1 class="text-2xl font-light">Profee WAAS Notificatioins API<!-- --> <!-- -->1.0</h1></div><ul class="text-sm mt-10 relative"><li class="mb-3"><a class="text-gray-700 no-underline hover:text-gray-900" href="#introduction">Introduction</a></li><li class="mb-3 mt-9"><a class="text-xs uppercase text-gray-700 mt-10 mb-4 font-thin hover:text-gray-900" href="#operations">Operations</a><ul class="text-sm mt-2"><li><a class="flex no-underline text-gray-700 mb-2 hover:text-gray-900" href="#operation-publish-card/authorization"><span class="bg-blue-600 font-bold h-6 no-underline text-white uppercase p-1 mr-2 rounded text-xs" title="Publish">Pub</span><span class="break-all inline-block">card/authorization</span></a></li></ul></li><li class="mb-3 mt-9"><a class="text-xs uppercase text-gray-700 mt-10 mb-4 font-thin hover:text-gray-900" href="#messages">Messages</a><ul class="text-sm mt-2"><li><a class="flex break-words no-underline text-gray-700 mt-2 hover:text-gray-900" href="#message-CardOperationNotificationDto"><div class="break-all inline-block">CardOperationNotificationDto</div></a></li></ul></li></ul></div></div></div><div class="panel--center relative py-8 flex-1"><div class="relative z-10"><div class="panel-item"><div class="panel-item--center px-8 text-left" id="introduction"><div class="text-4xl">Profee WAAS Notificatioins API<!-- --> <!-- -->1.0</div><div class="mt-4"><div class="prose max-w-none text-sm"><p>The following notifications will be sent to partner system. Please provide us with URLs which will be responsible in every notification.</p>
2022-04-08 11:50:41 +03:00
</div></div></div><div class="panel-item--right"></div></div><section id="operations" class="mt-16"><h2 class="2xl:w-7/12 text-3xl font-light mb-4 px-8">Operations</h2><ul><li class="mb-12" id="operation-publish-card/authorization"><div><div class="panel-item--center px-8"><div class="mb-4"><h3><span class="font-mono border uppercase p-1 rounded mr-2 border-blue-600 text-blue-500" title="publish">PUB</span> <span class="font-mono text-base">card/authorization</span></h3></div></div><div class="w-full mt-4" id="operation-publish-card/authorization-message"><div class="mt-2"><p class="px-8">Accepts the following message:</p><div class="mt-2"><div class="panel-item"><div class="panel-item--center px-8"><div class="shadow rounded bg-gray-200 p-4 border"><div><span class="border text-orange-600 rounded text-xs py-0 px-2">CardOperationNotificationDto</span></div><div class="mt-2"><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><button class="focus:outline-none undefined"><span class="break-words text-sm ">Payload</span><svg version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" class="inline-block align-baseline cursor-pointer -mb-1 w-5 transform transition-transform duration-150 ease-linear -rotate-90"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">object</div><div class="inline-block"></div></div></div></div><div class="rounded p-4 py-2 border bg-gray-100 hidden"><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">cardId</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div><div><div class="prose max-w-none text-sm"><p>Card ID</p>
2022-04-08 11:50:34 +03:00
</div></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">walletId</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div><div><div class="prose max-w-none text-sm"><p>Wallet ID</p>
</div></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><button class="focus:outline-none undefined"><span class="break-words text-sm italic">notification</span><svg version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" class="inline-block align-baseline cursor-pointer -mb-1 w-5 transform transition-transform duration-150 ease-linear -rotate-90"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">object</div><div class="inline-block"></div><div><div class="prose max-w-none text-sm"><p>Notification about card operation authorization</p>
2022-04-08 11:56:13 +03:00
</div></div></div></div></div><div class="rounded p-4 py-2 border bg-gray-100 bg-gray-200 hidden"><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">uuid</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">status</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><button class="focus:outline-none undefined"><span class="break-words text-sm italic">type</span><svg version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" class="inline-block align-baseline cursor-pointer -mb-1 w-5 transform transition-transform duration-150 ease-linear -rotate-90"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">object</div><div class="inline-block"></div></div></div></div><div class="rounded p-4 py-2 border bg-gray-100 hidden"><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">code</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">direction</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">description</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><p class="mt-2 text-xs text-gray-700">Additional properties are allowed.</p></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">mcc</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">number</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">authDate</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"><span class="bg-yellow-600 font-bold no-underline text-white rounded lowercase mr-2 p-1 text-xs">format: <!-- -->date</span></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">authTyme</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"><span class="bg-yellow-600 font-bold no-underline text-white rounded lowercase mr-2 p-1 text-xs">format: <!-- -->time</span></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">postingDate</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">authCode</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">rrn</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">number</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div c
2022-04-08 11:50:34 +03:00
<span class="hljs-attr">"cardId"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"walletId"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"notification"</span>: {
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"type"</span>: {
<span class="hljs-attr">"code"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"direction"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>
},
<span class="hljs-attr">"mcc"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"authDate"</span>: <span class="hljs-string">"2019-08-24"</span>,
2022-04-08 11:56:13 +03:00
<span class="hljs-attr">"authTyme"</span>: <span class="hljs-string">"14:15:22Z"</span>,
2022-04-08 11:50:34 +03:00
<span class="hljs-attr">"postingDate"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"authCode"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"rrn"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"merchantId"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"terminalId"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"merchantName"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"merchantCity"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"merchantSum"</span>: {
<span class="hljs-attr">"amount"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"currency"</span>: <span class="hljs-string">"string"</span>
},
<span class="hljs-attr">"cardSum"</span>: {
<span class="hljs-attr">"amount"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"currency"</span>: <span class="hljs-string">"string"</span>
},
<span class="hljs-attr">"authDescription"</span>: <span class="hljs-string">"string"</span>
}
2022-04-08 10:49:31 +03:00
}
</code></pre>
2022-04-08 11:50:34 +03:00
</div><h6 class="text-xs font-bold text-gray-600 italic mt-2">This example has been generated automatically.</h6></div></div></div></div></div></div></div></div></div></div></li></ul></section><section id="messages" class="mt-16"><h2 class="2xl:w-7/12 text-3xl font-light mb-4 px-8">Messages</h2><ul><li class="mb-4" id="message-CardOperationNotificationDto"><div class="panel-item"><div class="panel-item--center px-8"><div class="shadow rounded bg-gray-200 p-4 border"><div><span class="text-gray-700 font-bold mr-2">#<!-- -->1</span><span class="border text-orange-600 rounded text-xs py-0 px-2">CardOperationNotificationDto</span></div><div class="mt-2" id="message-CardOperationNotificationDto-payload"><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><button class="focus:outline-none undefined"><span class="break-words text-sm ">Payload</span><svg version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" class="inline-block align-baseline cursor-pointer -mb-1 w-5 transform transition-transform duration-150 ease-linear -rotate-90"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">object</div><div class="inline-block"></div></div></div></div><div class="rounded p-4 py-2 border bg-gray-100 hidden"><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">cardId</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div><div><div class="prose max-w-none text-sm"><p>Card ID</p>
</div></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">walletId</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div><div><div class="prose max-w-none text-sm"><p>Wallet ID</p>
</div></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><button class="focus:outline-none undefined"><span class="break-words text-sm italic">notification</span><svg version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" class="inline-block align-baseline cursor-pointer -mb-1 w-5 transform transition-transform duration-150 ease-linear -rotate-90"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">object</div><div class="inline-block"></div><div><div class="prose max-w-none text-sm"><p>Notification about card operation authorization</p>
2022-04-08 11:56:13 +03:00
</div></div></div></div></div><div class="rounded p-4 py-2 border bg-gray-100 bg-gray-200 hidden"><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">uuid</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">status</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><button class="focus:outline-none undefined"><span class="break-words text-sm italic">type</span><svg version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" class="inline-block align-baseline cursor-pointer -mb-1 w-5 transform transition-transform duration-150 ease-linear -rotate-90"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">object</div><div class="inline-block"></div></div></div></div><div class="rounded p-4 py-2 border bg-gray-100 hidden"><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">code</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">direction</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">description</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><p class="mt-2 text-xs text-gray-700">Additional properties are allowed.</p></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">mcc</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">number</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">authDate</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"><span class="bg-yellow-600 font-bold no-underline text-white rounded lowercase mr-2 p-1 text-xs">format: <!-- -->date</span></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">authTyme</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"><span class="bg-yellow-600 font-bold no-underline text-white rounded lowercase mr-2 p-1 text-xs">format: <!-- -->time</span></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">postingDate</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">authCode</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">string</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div class="min-w-1/4 mr-2"><span class="break-words text-sm italic">rrn</span></div><div><div><div class="capitalize text-sm text-teal-500 font-bold inline-block mr-2">number</div><div class="inline-block"></div></div></div></div></div><div><div class="flex py-2"><div c
2022-04-08 10:49:31 +03:00
<script src="js/asyncapi-ui.min.js" type="application/javascript"></script>
<script>
2022-04-08 11:56:13 +03:00
var schema = {"asyncapi":"2.3.0","info":{"title":"Profee WAAS Notificatioins API","version":"1.0","description":"The following notifications will be sent to partner system. Please provide us with URLs which will be responsible in every notification."},"channels":{"card/authorization":{"publish":{"message":{"payload":{"type":"object","properties":{"cardId":{"type":"string","description":"Card ID","x-parser-schema-id":"<anonymous-schema-2>"},"walletId":{"type":"string","description":"Wallet ID","x-parser-schema-id":"<anonymous-schema-3>"},"notification":{"type":"object","description":"Notification about card operation authorization","properties":{"uuid":{"type":"string","x-parser-schema-id":"<anonymous-schema-5>"},"status":{"type":"string","x-parser-schema-id":"<anonymous-schema-6>"},"type":{"type":"object","properties":{"code":{"type":"string","x-parser-schema-id":"<anonymous-schema-8>"},"direction":{"type":"string","x-parser-schema-id":"<anonymous-schema-9>"},"description":{"type":"string","x-parser-schema-id":"<anonymous-schema-10>"}},"x-parser-schema-id":"<anonymous-schema-7>"},"mcc":{"type":"number","x-parser-schema-id":"<anonymous-schema-11>"},"authDate":{"type":"string","format":"date","x-parser-schema-id":"<anonymous-schema-12>"},"authTyme":{"type":"string","format":"time","x-parser-schema-id":"<anonymous-schema-13>"},"postingDate":{"type":"string","x-parser-schema-id":"<anonymous-schema-14>"},"authCode":{"type":"string","x-parser-schema-id":"<anonymous-schema-15>"},"rrn":{"type":"number","x-parser-schema-id":"<anonymous-schema-16>"},"merchantId":{"type":"number","x-parser-schema-id":"<anonymous-schema-17>"},"terminalId":{"type":"number","x-parser-schema-id":"<anonymous-schema-18>"},"merchantName":{"type":"string","x-parser-schema-id":"<anonymous-schema-19>"},"merchantCity":{"type":"string","x-parser-schema-id":"<anonymous-schema-20>"},"merchantSum":{"type":"object","properties":{"amount":{"type":"number","x-parser-schema-id":"<anonymous-schema-22>"},"currency":{"type":"string","x-parser-schema-id":"<anonymous-schema-23>"}},"x-parser-schema-id":"<anonymous-schema-21>"},"cardSum":{"type":"object","properties":{"amount":{"type":"number","x-parser-schema-id":"<anonymous-schema-25>"},"currency":{"type":"string","x-parser-schema-id":"<anonymous-schema-26>"}},"x-parser-schema-id":"<anonymous-schema-24>"},"authDescription":{"type":"string","x-parser-schema-id":"<anonymous-schema-27>"}},"x-parser-schema-id":"<anonymous-schema-4>"}},"x-parser-schema-id":"<anonymous-schema-1>"},"x-parser-original-schema-format":"application/vnd.aai.asyncapi;version=2.3.0","x-parser-original-payload":{"type":"object","properties":{"cardId":{"type":"string","description":"Card ID"},"walletId":{"type":"string","description":"Wallet ID"},"notification":{"type":"object","description":"Notification about card operation authorization","properties":{"uuid":{"type":"string"},"status":{"type":"string"},"type":{"type":"object","properties":{"code":{"type":"string"},"direction":{"type":"string"},"description":{"type":"string"}}},"mcc":{"type":"number"},"authDate":{"type":"string","format":"date"},"authTyme":{"type":"string","format":"time"},"postingDate":{"type":"string"},"authCode":{"type":"string"},"rrn":{"type":"number"},"merchantId":{"type":"number"},"terminalId":{"type":"number"},"merchantName":{"type":"string"},"merchantCity":{"type":"string"},"merchantSum":{"type":"object","properties":{"amount":{"type":"number"},"currency":{"type":"string"}}},"cardSum":{"type":"object","properties":{"amount":{"type":"number"},"currency":{"type":"string"}}},"authDescription":{"type":"string"}}}}},"schemaFormat":"application/vnd.aai.asyncapi;version=2.3.0","x-parser-message-parsed":true,"x-parser-message-name":"CardOperationNotificationDto"}}}},"components":{"messages":{"CardOperationNotificationDto":"$ref:$.channels.card/authorization.publish.message"}},"x-parser-spec-parsed":true,"x-parser-spec-stringified":true};
2022-04-08 10:49:31 +03:00
var config = {"show":{"sidebar":true},"sidebar":{"showOperations":"byDefault"}};
AsyncApiStandalone.hydrate({ schema, config }, document.getElementById("root"));
</script>
</body>
</html>