{"info":{"_postman_id":"39735793-87c9-439d-8b4b-391ddd239cec","name":"Noqoody Pay Sandbox API Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"8233756","collectionId":"39735793-87c9-439d-8b4b-391ddd239cec","publishedId":"UV5WDxk8","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-10-17T12:53:01.000Z"},"item":[{"name":"Token","id":"dfbcf6a1-8304-402d-96ef-6e28a4038cd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"username_here","type":"text"},{"key":"password","value":"password_here","type":"text"}]},"url":"https://sandbox.enoqoody.com/token","description":"

This API will be used to call the token

\n","urlObject":{"protocol":"https","path":["token"],"host":["sandbox","enoqoody","com"],"query":[],"variable":[]}},"response":[{"id":"00198426-8ba8-48f0-b26e-8d07a948a1d1","name":"Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"username_here","type":"text"},{"key":"password","value":"password_here","type":"text"}]},"url":"https://sandbox.enoqoody.com/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Dec 2022 08:31:51 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":".AspNet.Cookies=YiqqrDSKWOdp2AwbqhZNCIhaJG7XVMPkQDcrxtOvrxd-KpE_Gn3gJcyu65imcdlcudLClORBHRJMcBFCUUGEz0z6s8Cu-ZDJPT4dAz0v-dFy4TtdkQHr-JSRiwVAKfMUv3NuqCYQ5Cw49wBKS8_K9wt1erkUEhDzNJUJbgz4LAbB4X7kcu3sTs3fZC17FTe0p7h6Q6ZEsdRjBEFpYf_gabsj7cEA66q-3j4uZP88l5YVB9gzus2LTkwPiFhfFwMjE9eutPl214t-PG18jmz5ruHt2ENdErJQCm-YbE1JTXv2cLsxlLTrNlkQ92KpHRZZ1lcLSpLFHFEC9WWh5urQD4hXvFXJjiRCQVHuVv_tEdiRnJP-EYKkcfc8ENx7rExetF2WwcoG_yqPc3WSsoV46ehye6Jn2eYdAgu-aYShK5gG3BiTEVK94lUFcCTroC5ibwbMNBM2TSRdMWlB1xEL0sNCmX5yA-V5uf42l_kOVRR1EWjVnzrGl4Vk9811Y3bYmE3V-21NlNft_T1Y9wc0AA; path=/; HttpOnly"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=u3RV%2FkBfM22AaTTll9MRqBobX%2FZbZUJd28ZETW2GpKdtbkuQrmGqRdly1mduKx8LovhKzfKOor%2F%2BGrT6aVF2YVwMuRujfWuaYhw1Ozs5GoIhnytn4WJ3CDcQbqVvxO7NVfoOW7%2BnAw%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"78112e864a39d055-KHI"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"bearer_token_will_be_here\",\n \"token_type\": \"bearer\",\n \"expires_in\": 1209599,\n \"userName\": \"your_username\",\n \"Name\": \"Owner_Name\",\n \"Role\": \"NoqoodayPay User\",\n \"ImageLocation\": \"image_location_link\",\n \"Email\": \"registered_email_address\",\n \".issued\": \"Thu, 29 Dec 2022 08:30:21 GMT\",\n \".expires\": \"Thu, 12 Jan 2023 08:30:21 GMT\"\n}"}],"_postman_id":"dfbcf6a1-8304-402d-96ef-6e28a4038cd0"},{"name":"Generate Link & Session","id":"ec1da808-fa48-4ab4-87bb-cb8de5df0772","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ProjectCode\": \"your_project_code\",\r\n \"Description\": \"description_less_than_40_characters_without_special_characters\",\r\n \"Amount\": 1.00,\r\n \"CustomerEmail\": \"customer@email.com\",\r\n \"CustomerMobile\": \"customer_mobile\",\r\n \"CustomerName\": \"customer_name\",\r\n \"SecureHash\": \"SHA256 Hash Value\",\r\n \"Reference\": \"your_unique_reference\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.enoqoody.com/api/PaymentLink/GenerateLinks","description":"

This API will generate the payment url which will directly redirect the user to Noqoody where the payment will be handeled automatically by the Noqoody System or the SessionID and UUID can be used in the PaymentChannels API for generatinig the links separately.

\n

The SessionID and UUID in this API will be used for the PaymentChannel API in which all the payment options will be displayed in the form of an array with their respective links

\n

How to generate Secure Hash (SHA256)

\n

Please use the following link for reference on how to generate secure hash

\n

https://www.jokecamp.com/blog/examples-of-creating-base64-hashes-using-hmac-sha256-in-different-languages/#js

\n

Format: {CustomerEmail}{CustomerName}{CustomerMobile}{Description}{ProjectCode}{Reference}{Amount}

\n

Please make sure that amount is in 2 decimal places. 3 decimal places will result in an invalid secure hash

\n

You will need the Client Secret Key as the key value to generate the securehash

\n

Secret Key & Project code can be retrieved from the Get Account Details section in this document

\n","urlObject":{"protocol":"https","path":["api","PaymentLink","GenerateLinks"],"host":["sandbox","enoqoody","com"],"query":[],"variable":[]}},"response":[{"id":"dbcbb189-b108-493b-8528-0ec69328c33b","name":"Generate Link & Session","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ProjectCode\": \"your_project_code_here\",\r\n \"Description\": \"Order\",\r\n \"Amount\": 1,\r\n \"CustomerEmail\": \"abdullahsultan14@gmail.com\",\r\n \"CustomerMobile\": \"97455747140\",\r\n \"CustomerName\": \"Abdullah\",\r\n \"SecureHash\": \"HGuIJLVHf\\/vf5yJBddrk80MAz4nU1g+WBFTt4fEoJCw=\",\r\n \"Reference\": \"po6qrnn8IF\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.enoqoody.com/api/PaymentLink/GenerateLinks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Dec 2022 08:35:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"X-Aspnet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=g3ixLyqJIRHgRJv7gZzSuvPIoJgyZYfSCH70R%2F6%2F6yiEAnqzkJf4sQm4Z49Pot3yg1ngJKv7pNs9oZUZJtcf2eISYyZhn9N%2FEwY1Hq0dZYgv7xI7NGuNVDWzfr31lRTarWeuft6PaA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"781133d0f9d0d055-KHI"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"PaymentUrl\": \"https://sandbox.enoqoody.com/payment.html?session_id=f04ddb54-3463-435e-8ddf-808849b0d07d&uuid=271189781\",\n \"ProjectCode\": \"your_project_code\",\n \"Reference\": \"po6qrnn8IF\",\n \"Description\": \"Order\",\n \"Amount\": 1,\n \"CustomerEmail\": \"abdullahsultan14@gmail.com\",\n \"CustomerName\": \"Abdullah\",\n \"CustomerMobile\": \"97455747140\",\n \"SessionId\": \"f04ddb54-3463-435e-8ddf-808849b0d07d\",\n \"Uuid\": \"271189781\",\n \"success\": true,\n \"code\": \"OK\",\n \"message\": \"Payment Link Generated\",\n \"errors\": []\n}"}],"_postman_id":"ec1da808-fa48-4ab4-87bb-cb8de5df0772"},{"name":"Generating Payment Channels","id":"a99e0d81-18d1-4709-9ab4-b7f28c8e703b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.enoqoody.com/api/PaymentLink/PaymentChannels?session_id=sessionid_here&uuid=uuid_here","description":"

This API will consume the SessionID and UUID generated by GenerateLinks API and will return the list of payment channels along with the transacion details

\n","urlObject":{"protocol":"https","path":["api","PaymentLink","PaymentChannels"],"host":["sandbox","enoqoody","com"],"query":[{"key":"session_id","value":"sessionid_here"},{"key":"uuid","value":"uuid_here"}],"variable":[]}},"response":[{"id":"168974af-dc0d-440d-9589-25099e4dbf39","name":"Generating Payment Channels","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.enoqoody.com/api/PaymentLink/PaymentChannels?session_id=session_id_here&uuid=uuid_here","protocol":"https","host":["sandbox","enoqoody","com"],"path":["api","PaymentLink","PaymentChannels"],"query":[{"key":"session_id","value":"session_id_here"},{"key":"uuid","value":"uuid_here"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Dec 2022 08:37:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"X-Aspnet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=EqATcI%2F2Rj%2BoYYSKURwoOsojFVaTD5IOcBPvJypqOPf0LDdC7QhjjOghCR6B1iOTvosItVACkOdOPLo4KqWXMSsK2iLLgQ%2FrgvpVPUuLCQOu3m0%2BcvfnVki9EBdY58KKvOslZ9wWmw%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"781136588ea4d055-KHI"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"PaymentChannels\": [\n {\n \"ID\": 321062,\n \"ChannelName\": \"Credit Card (QB)\",\n \"ImageLocation\": \"https://www.noqoodypay.com/API/images\\\\sdk\\\\credit-card.png\",\n \"PaymentURL\": \"https://sandbox.enoqoody.com/api/PaymentLink/ProcessPayment?session_id=f04ddb54-3463-435e-8ddf-808849b0d07d&uuid=271189781&channel_name=Credit Card (QB)&id=321062\",\n \"ServiceTypeID\": 2,\n \"ServiceTypeName\": \"Credit Card Payment\"\n },\n {\n \"ID\": 321063,\n \"ChannelName\": \"Vodafone\",\n \"ImageLocation\": \"https://www.noqoodypay.com/API/images\\\\sdk\\\\vodafone.png\",\n \"PaymentURL\": \"https://sandbox.enoqoody.com/payment.html?session_id=20191d90-1d9b-4888-ad6c-b6104d2fc123&uuid=336311401\",\n \"ServiceTypeID\": 1,\n \"ServiceTypeName\": \"Mobile Payment\"\n },\n {\n \"ID\": 321064,\n \"ChannelName\": \"Naps\",\n \"ImageLocation\": \"https://www.noqoodypay.com/API/images\\\\sdk\\\\naps.png\",\n \"PaymentURL\": \"https://sandbox.enoqoody.com/api/PaymentLink/ProcessPayment?session_id=f04ddb54-3463-435e-8ddf-808849b0d07d&uuid=271189781&channel_name=Naps&id=321064\",\n \"ServiceTypeID\": 3,\n \"ServiceTypeName\": \"Debit Card Payment\"\n },\n {\n \"ID\": 321065,\n \"ChannelName\": \"Ooredoo\",\n \"ImageLocation\": \"https://www.noqoodypay.com/API/images\\\\sdk\\\\ooredoo.png\",\n \"PaymentURL\": \"https://sandbox.enoqoody.com/payment.html?session_id=79e99279-9e4a-4783-a73e-c01ea519c259&uuid=659235925\",\n \"ServiceTypeID\": 1,\n \"ServiceTypeName\": \"Mobile Payment\"\n },\n {\n \"ID\": 321067,\n \"ChannelName\": \"Credit Card (MPGS)\",\n \"ImageLocation\": \"https://www.noqoodypay.com/API/images\\\\sdk\\\\credit-card.png\",\n \"PaymentURL\": \"https://sandbox.enoqoody.com/api/PaymentLink/ProcessPayment?session_id=f04ddb54-3463-435e-8ddf-808849b0d07d&uuid=271189781&channel_name=Credit Card (MPGS)&id=321067\",\n \"ServiceTypeID\": 2,\n \"ServiceTypeName\": \"Credit Card Payment\"\n }\n ],\n \"TransactionDetail\": {\n \"MerchantName\": \"QMobile Middle East\",\n \"TransactionDescription\": \"Order\",\n \"Amount\": 1,\n \"Reference\": \"po6qrnn8IF\",\n \"MobileNumber\": \"97433860011\",\n \"Email\": \"abdullah@qmobileme.com\",\n \"CustomerEmail\": \"abdullahsultan14@gmail.com\",\n \"CustomerMobile\": \"97455747140\",\n \"CustomerName\": \"Abdullah\",\n \"MerchantLogo\": \"https://members.noqoodypay.com/V2/\\\\Uploads/Registeration/imagepath/2022-03-12_12-12-24_logothumbnail-logo.jpg\",\n \"Website\": \"https://qmobileme.com\",\n \"RedirectURl\": \"https://noqoody.com/paymentStatus.html?\"\n },\n \"ServiceTypeList\": [\n {\n \"ID\": 1,\n \"Text\": \"Mobile Payment\"\n },\n {\n \"ID\": 2,\n \"Text\": \"Credit Card Payment\"\n },\n {\n \"ID\": 3,\n \"Text\": \"Debit Card Payment\"\n },\n {\n \"ID\": 4,\n \"Text\": \"Online Payment\"\n },\n {\n \"ID\": 5,\n \"Text\": \"Online Wallet Payment\"\n }\n ],\n \"success\": true,\n \"code\": \"200\",\n \"message\": \"\",\n \"errors\": []\n}"}],"_postman_id":"a99e0d81-18d1-4709-9ab4-b7f28c8e703b"},{"name":"Validate Payment","id":"d9724d6d-857d-41c9-b03f-4e9e85dbce59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://sandbox.enoqoody.com/api/Members/GetTransactionDetailStatusByClientReference/?ReferenceNo=your_unique_reference","description":"

This API will validate the payment using your unique reference

\n","urlObject":{"protocol":"https","path":["api","Members","GetTransactionDetailStatusByClientReference",""],"host":["sandbox","enoqoody","com"],"query":[{"key":"ReferenceNo","value":"your_unique_reference"}],"variable":[]}},"response":[],"_postman_id":"d9724d6d-857d-41c9-b03f-4e9e85dbce59"},{"name":"Get Account Details","id":"b1e19901-f909-44a4-8d75-e8979d08ada6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.enoqoody.com/api/Members/GetUserSettings","urlObject":{"protocol":"https","path":["api","Members","GetUserSettings"],"host":["sandbox","enoqoody","com"],"query":[],"variable":[]}},"response":[{"id":"ab9c5973-fe75-4678-9ca8-08f56d91d1d7","name":"Get Account Details","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.enoqoody.com/api/Members/GetUserSettings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Mar 2023 08:12:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"http://94.229.73.210:4546"},{"key":"Cache-Control","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=DzxILjizeRo%2F%2FjxDlJkzxZ%2BcAevIRoQrX97fJkpDySKbD9aP6vjfLK1rryLFlAY2XYFoJKBVr%2BLGtKN%2BozK7lxulEjkEQE0iTMGSQcamwpiaThgVvUmNySm7FqmtY9GdqsVKgVoFAQ%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7a415f1d4b8e411e-ISB"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"UserProjects\": [\n {\n \"ID\": 0,\n \"ProjectName\": \"Project Name\",\n \"ProjectDescription\": \"Online Payment Gateway\",\n \"ProjectCode\": \"Project Code\",\n \"ClientSecret\": \"Secret Key\",\n \"AccessURL\": \"Access URL\",\n \"IsActive\": true,\n \"ServicesList\": [\n {\n \"ID\": 0,\n \"ServiceID\": 0,\n \"IsActive\": true,\n \"ServiceName\": \"Service Name\",\n \"ServiceDescription\": \"Service Description\",\n \"RedirctUrl\": \"Redirect URL\"\n }\n ]\n }\n ],\n \"success\": true,\n \"code\": \"OK\",\n \"message\": \"\",\n \"errors\": []\n}"}],"_postman_id":"b1e19901-f909-44a4-8d75-e8979d08ada6"}]}