{"info":{"_postman_id":"5be350e5-abfa-4002-9da6-a20eba88b5f8","name":"Noqoody Pay API Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"8233756","collectionId":"5be350e5-abfa-4002-9da6-a20eba88b5f8","publishedId":"UUxz9SQD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-09-27T11:10:58.000Z"},"item":[{"name":"Token","id":"f3c8728c-0b50-4306-81ea-ccfaac0e6b09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"noqoody_user_name","type":"text"},{"key":"password","value":"noqoody_password","type":"text"}]},"url":"https://noqoodypay.com/sdk/token","description":"

This API will be used to call the token

\n","urlObject":{"protocol":"https","path":["sdk","token"],"host":["noqoodypay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3c8728c-0b50-4306-81ea-ccfaac0e6b09"},{"name":"Generate Link & Session","id":"cde03295-31de-4ddd-a121-b4eb3365b3be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ProjectCode\": \"your_project_code\",\r\n \"Description\": \"order_description_less_than_40_characters_with_no_special_characters\",\r\n \"Amount\": \"45.00\",\r\n \"CustomerEmail\": \"customers_email\",\r\n \"CustomerMobile\": \"customers_mobile_number\",\r\n \"CustomerName\": \"customers_name\",\r\n \"SecureHash\": \"secure_hash\",\r\n \"Reference\": \"reference_id\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://noqoodypay.com/sdk/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.

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

How to generate Secure Hash (SHA256)

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

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

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

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

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

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

\n","urlObject":{"protocol":"https","path":["sdk","api","PaymentLink","GenerateLinks"],"host":["noqoodypay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cde03295-31de-4ddd-a121-b4eb3365b3be"},{"name":"Generating Payment Channels","id":"e235ba36-f401-4149-adfd-49e29b279764","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://noqoodypay.com/sdk/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":["sdk","api","PaymentLink","PaymentChannels"],"host":["noqoodypay","com"],"query":[{"key":"session_id","value":"sessionid_here"},{"key":"uuid","value":"uuid_here"}],"variable":[]}},"response":[],"_postman_id":"e235ba36-f401-4149-adfd-49e29b279764"},{"name":"Validate Payment","id":"e7d5308a-6ecd-4a53-879a-948d6f40b9b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.noqoodypay.com/sdk/api/Members/GetTransactionDetailStatusByClientReference/?ReferenceNo={your_unique_reference}","description":"

This API will validate the payment using your unique reference

\n","urlObject":{"protocol":"https","path":["sdk","api","Members","GetTransactionDetailStatusByClientReference",""],"host":["www","noqoodypay","com"],"query":[{"key":"ReferenceNo","value":"{your_unique_reference}"}],"variable":[]}},"response":[],"_postman_id":"e7d5308a-6ecd-4a53-879a-948d6f40b9b3"},{"name":"Get Account Details","id":"fc6c422c-8d11-4153-8471-0df95a6ae764","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://noqoodypay.com/sdk/api/Members/GetUserSettings","urlObject":{"protocol":"https","path":["sdk","api","Members","GetUserSettings"],"host":["noqoodypay","com"],"query":[],"variable":[]}},"response":[{"id":"4b6c3260-d991-4019-a0f7-fe5c2ec11e80","name":"Get Account Details","originalRequest":{"method":"GET","header":[],"url":"https://noqoodypay.com/sdk/api/Members/GetUserSettings"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"UserProjects\": [\r\n {\r\n \"ID\": 0,\r\n \"ProjectName\": \"Project Name\",\r\n \"ProjectDescription\": \"Online Payment Gateway\",\r\n \"ProjectCode\": \"Project Code\",\r\n \"ClientSecret\": \"Secret Key\",\r\n \"AccessURL\": \"Access URL\",\r\n \"IsActive\": true,\r\n \"ServicesList\": [\r\n {\r\n \"ID\": 0,\r\n \"ServiceID\": 0,\r\n \"IsActive\": true,\r\n \"ServiceName\": \"Service Name\",\r\n \"ServiceDescription\": \"Service Description\",\r\n \"RedirctUrl\": \"Redirect URL\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"success\": true,\r\n \"code\": \"OK\",\r\n \"message\": \"\",\r\n \"errors\": []\r\n}"}],"_postman_id":"fc6c422c-8d11-4153-8471-0df95a6ae764"}]}