{"info":{"_postman_id":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","name":"TwoDApi","description":"

The 2D API Offers A Simple And Convenient Programmable Interface To Initiate Request To Pay \"Transaction Requests\" With The Added Function And Transaction Capability Similar To A Smart Contract Based On The Blockchain. The 2D Transact Process Turns Traditional Transactions Into Intelligent Transactions, Especially In The Payments And Settlement Space

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11639743","collectionId":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","publishedId":"UzXVsYfi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"29A5DC"},"publishDate":"2022-08-11T12:54:43.000Z"},"item":[{"name":"API Admin","item":[{"name":"Health Check","id":"1c470471-6a5f-45b6-8cd0-1a22fed5e1ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocol}}://{{host}}/api/actuator/health","description":"

Will allow the user to do a check to see if the 2D Controller is up.

Lists the current Device Types in in the 2D Controller; which are:

Payee and Initiator

Initiator's are devices that when created will create the ability for 2D Codes to be generated from that device/s.

Payee's are devices that when created will create the ability for 2D Codes to be paid in that Controller, that have been generated by the Initiators.

\n","urlObject":{"protocol":"{{protocol}}","path":["api","admin","v1","getDeviceTypes"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"50b64703-c156-4b2b-91a2-342b2639e17e","name":"GetDeviceTypes","originalRequest":{"method":"GET","header":[],"url":"{{protocol}}://{{host}}/api/admin/v1/getDeviceTypes"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"10548186702110234\",\r\n \"responseCode\": \"000\",\r\n \"responseDescription\": \"Success\",\r\n \"deviceTypes\": [\r\n {\r\n \"type\": \"Initiator\",\r\n \"code\": \"001\"\r\n },\r\n {\r\n \"type\": \"Payee\",\r\n \"code\": \"002\"\r\n }\r\n ]\r\n}"}],"_postman_id":"2ee314a1-78f1-42b6-a1f8-907215c043f4"},{"name":"CreateDevice","id":"4a1120ff-b64e-4fa1-a912-5481d2dbe054","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"{{transactionId}}\",\n\t\"identifier\": \"{{identifier}}\",\n\t\"deviceTypeCode\": \"{{deviceTypeCode}}\"\n}"},"url":"{{protocol}}://{{host}}/api/admin/v1/createDevice","description":"

The Device Types can be created on this call;

Initiator Code = 001

Payee Code = 002

Its IMPORTANT to keep the secretKey safely for future use.

\n","urlObject":{"protocol":"{{protocol}}","path":["api","admin","v1","createDevice"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"a93b5815-25b4-447f-b3d0-10c4b9086b52","name":"CreateDevice","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"{{transactionId}}\",\n\t\"identifier\": \"{{identifier}}\",\n\t\"deviceTypeCode\": \"{{deviceTypeCode}}\"\n}"},"url":"{{protocol}}://{{host}}/api/admin/v1/createDevice"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"10548231165040056\",\r\n \"responseCode\": \"000\",\r\n \"responseDescription\": \"Success\",\r\n \"secretKey\": \"813549d4-b875-4051-8184-b018bbdce699\",\r\n \"message\": \"Keep this safe and do not lose it\"\r\n}"}],"_postman_id":"4a1120ff-b64e-4fa1-a912-5481d2dbe054"},{"name":"DisableDevice","id":"7dc82fd6-de64-4912-8865-c9e01faa8c10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"{{transactionId}}\",\n\t\"identifier\": \"{{identifier}}\"\n}"},"url":"{{protocol}}://{{host}}/api/admin/v1/disableDevice","description":"

Created Devices can be disabled if they should no longer be used.

\n","urlObject":{"protocol":"{{protocol}}","path":["api","admin","v1","disableDevice"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"33621654-85ba-44ce-8099-784e595c7331","name":"DisableDevice","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"{{transactionId}}\",\n\t\"identifier\": \"{{identifier}}\"\n}"},"url":"{{protocol}}://{{host}}/api/admin/v1/disableDevice"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7dc82fd6-de64-4912-8865-c9e01faa8c10"}],"id":"c509e081-439b-4c8b-b1d3-9ea772ea1499","description":"

In order to use the API you will need to be provided with a User Name and Password.

\n","_postman_id":"c509e081-439b-4c8b-b1d3-9ea772ea1499","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","id":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","name":"TwoDApi","type":"collection"}}},{"name":"TwoD Transact","item":[{"name":"Admin","item":[{"name":"Create Account","event":[{"listen":"prerequest","script":{"id":"8ff115e6-4341-42d8-b4e7-e78791f47645","exec":["function getPath(url) {\r"," var pathRegex = /.+?\\:\\/\\/.+?(\\/.+?)(?:#|\\?|$)/;\r"," var result = url.match(pathRegex);\r"," return result && result.length > 1 ? result[1] : ''; \r","}\r"," \r","function getQueryString(url) {\r"," var arrSplit = url.split('?');\r"," return arrSplit.length > 1 ? url.substring(url.indexOf('?')+1) : ''; \r","}\r","\r","function getAuthHeader(httpMethod, requestUrl, requestBody) {\r"," // var CLIENT_KEY = 'JohnnyBoy';\r"," var SECRET_KEY = environment.secret_creator;\r"," // var SECRET_KEY = 'Test';\r"," var AUTH_TYPE = 'HMAC-SHA512';\r"," \r"," var requestPath = getPath(requestUrl);\r"," var queryString = getQueryString(requestUrl);\r"," if (httpMethod == 'GET' || !requestBody) {\r"," requestBody = ''; \r"," } else {\r"," //requestBody = JSON.stringify(requestBody);\r"," }\r"," console.log(\"requestBody: \" + requestBody);\r"," \r"," //var hashedPayload = CryptoJS.enc.Hex.stringify(CryptoJS.SHA512(requestBody));\r"," //console.log(\"hashedPayload: \" + hashedPayload);\r"," \r"," //var timestamp = new Date().toISOString().split('.')[0]+\"Z\";\r"," //console.log(\"timestamp: \" + timestamp);\r"," \r"," //var requestData = [httpMethod, requestPath, queryString, timestamp, hashedPayload].join(\"\\n\");\r"," //console.log(\"requestData: \" + requestData);\r"," \r"," //var hashedRequestData = CryptoJS.enc.Hex.stringify(CryptoJS.SHA512(requestData));\r"," //console.log(\"hashedRequestData: \" + hashedRequestData);\r"," \r"," //var hmacDigest = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(hashedRequestData, SECRET_KEY));\r"," var hmacDigest = CryptoJS.HmacSHA512(requestBody, SECRET_KEY);\r"," console.log(\"Signature: \" + hmacDigest);\r"," \r"," return hmacDigest;\r","}\r","\r","postman.setEnvironmentVariable('signature', getAuthHeader(request['method'], request['url'], request['data']));"],"type":"text/javascript"}}],"id":"7ce79410-2bb1-4bc9-8548-19ecfb7654bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"signature","value":"{{signature}}","type":"text"},{"key":"identifier","value":"{{identifier_creator}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"{{transactionId}}\",\n\t\"firstName\":\"{{firstName}}\", \n\t\"lastName\":\"{{lastName}}\", \n\t\"gender\":\"{{gender}}\", \n\t\"idNumber\":\"{{idNumber}}\", \n\t\"mobileNumber\":\"{{mobileNumber}}\", \n\t\"email\":\"{{email}}\", \n\t\"telNumber\":\"{{telNumber}}\", \n\t\"faxNumber\":\"{{faxNumber}}\", \n\t\"community\":\"{{community}}\", \n\t\"streetAddress1\":\"{{streetAddress1}}\", \n\t\"streetAddress2\":\"{{streetAddress2}}\", \n\t\"streetAddress3\":\"{{streetAddress3}}\", \n\t\"accountType\":\"{{accountType}}\", \n\t\"dateOfBirth\":\"{{dateOfBirth}}\",\n\t\"dynamicFields\": [\n\t\t{\n\t\t\t\"group\": \"{{group}}\",\n\t\t\t\"name\": \"{{name}}\",\n\t\t\t\"value\": \"{{value}}\"\n\t\t},\n\t\t{\n\t\t\t\"group\": \"{{group}}\",\n\t\t\t\"name\": \"{{name}}\",\n\t\t\t\"value\": \"{{value}}\"\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{host}}/api/twod/v1/account/create/","description":"

Create accounts in the 2D Controller so that 2D codes can be created and Paid/Withdrawn or Deposited

Account balances can be settled into Merchants bank accounts, the call can be used to create a settlement amount. i.e. the Merchant entire account balance doesnt have to be settled at once.

Provides a list of available codes i.e. Pay Code 001, Withdraw Code 002 and Deposit Code 003.

Note: A Pay code cannot be used to try and Withdraw it, for example.

Used to create codes to Pay, Withdraw and Deposit. The codeType values determine which code is being created.

Used by a Merchant to query the status of a code, codes can be in one of the following states;

Pending = awaiting payment

Claimed = paid

Expired = expired

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","id":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","name":"TwoDApi","type":"collection"}},"urlObject":{"protocol":"{{protocol}}","path":["api","twod","v1","query",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"85e0c3f0-1ae2-40d3-bd2c-53278f77c1f3","name":"Query Code","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"signature","value":"{{signature}}","type":"text"},{"key":"identifier","value":"{{identifier_creator}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"{{transactionId}}\",\n\t\"code\": \"{{code}}\"\n}"},"url":"{{protocol}}://{{host}}/api/twod/v1/query/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"10549204157658700\",\r\n \"responseCode\": \"000\",\r\n \"responseDescription\": \"Success\",\r\n \"authCode\": \"4662\",\r\n \"transactionId\": \"54646464\",\r\n \"status\": \"New\",\r\n \"amount\": \"1000\",\r\n \"timeToLive\": \"565107\",\r\n \"description\": \"John\"\r\n}"}],"_postman_id":"cf942cdc-2af9-4ea8-a2f9-17155fced9a7"},{"name":"List Code States","event":[{"listen":"prerequest","script":{"id":"de358eec-71ab-4391-91eb-1481ac25fa34","exec":["function getPath(url) {\r"," var pathRegex = /.+?\\:\\/\\/.+?(\\/.+?)(?:#|\\?|$)/;\r"," var result = url.match(pathRegex);\r"," return result && result.length > 1 ? result[1] : ''; \r","}\r"," \r","function getQueryString(url) {\r"," var arrSplit = url.split('?');\r"," return arrSplit.length > 1 ? url.substring(url.indexOf('?')+1) : ''; \r","}\r","\r","function getAuthHeader(httpMethod, requestUrl, requestBody) {\r"," // var CLIENT_KEY = 'JohnnyBoy';\r"," var SECRET_KEY = environment.secret_creator;\r"," // var SECRET_KEY = 'Test';\r"," var AUTH_TYPE = 'HMAC-SHA512';\r"," \r"," var requestPath = getPath(requestUrl);\r"," var queryString = getQueryString(requestUrl);\r"," if (httpMethod == 'GET' || !requestBody) {\r"," requestBody = ''; \r"," } else {\r"," //requestBody = JSON.stringify(requestBody);\r"," }\r"," console.log(\"requestBody: \" + requestBody);\r"," \r"," //var hashedPayload = CryptoJS.enc.Hex.stringify(CryptoJS.SHA512(requestBody));\r"," //console.log(\"hashedPayload: \" + hashedPayload);\r"," \r"," //var timestamp = new Date().toISOString().split('.')[0]+\"Z\";\r"," //console.log(\"timestamp: \" + timestamp);\r"," \r"," //var requestData = [httpMethod, requestPath, queryString, timestamp, hashedPayload].join(\"\\n\");\r"," //console.log(\"requestData: \" + requestData);\r"," \r"," //var hashedRequestData = CryptoJS.enc.Hex.stringify(CryptoJS.SHA512(requestData));\r"," //console.log(\"hashedRequestData: \" + hashedRequestData);\r"," \r"," //var hmacDigest = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(hashedRequestData, SECRET_KEY));\r"," var hmacDigest = CryptoJS.HmacSHA512(requestBody, SECRET_KEY);\r"," console.log(\"Signature: \" + hmacDigest);\r"," \r"," return hmacDigest;\r","}\r","\r","postman.setEnvironmentVariable('signature', getAuthHeader(request['method'], request['url'], request['data']));"],"type":"text/javascript"}}],"id":"a9d81beb-765f-49b0-a6fa-0b012a7caba3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"identifier","value":"{{identifier_creator}}","type":"text"},{"key":"signature","value":"{{signature}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"{{transactionId}}\"\n}"},"url":"{{protocol}}://{{host}}/api/twod/v1/listStates","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","id":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","name":"TwoDApi","type":"collection"}},"urlObject":{"protocol":"{{protocol}}","path":["api","twod","v1","listStates"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"bd4cd26f-0b4a-4dea-967b-1ec13e5f0e3a","name":"List Code States","originalRequest":{"method":"POST","header":[{"key":"identifier","value":"{{identifier_creator}}","type":"text"},{"key":"signature","value":"{{signature}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"{{transactionId}}\"\n}"},"url":"{{protocol}}://{{host}}/api/twod/v1/listStates"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"10549260122862652\",\r\n \"responseCode\": \"000\",\r\n \"responseDescription\": \"Success\",\r\n \"authCode\": \"4664\",\r\n \"transactionId\": \"65456546546546\",\r\n \"codeStates\": [\r\n \"ALL\",\r\n \"Pending\",\r\n \"Paid\",\r\n \"Expired\",\r\n \"Reversed\"\r\n ]\r\n}"}],"_postman_id":"a9d81beb-765f-49b0-a6fa-0b012a7caba3"},{"name":"List Codes","event":[{"listen":"prerequest","script":{"id":"97c43be2-db40-452c-b6a1-24c327cc17f4","exec":["function getPath(url) {\r"," var pathRegex = /.+?\\:\\/\\/.+?(\\/.+?)(?:#|\\?|$)/;\r"," var result = url.match(pathRegex);\r"," return result && result.length > 1 ? result[1] : ''; \r","}\r"," \r","function getQueryString(url) {\r"," var arrSplit = url.split('?');\r"," return arrSplit.length > 1 ? url.substring(url.indexOf('?')+1) : ''; \r","}\r","\r","function getAuthHeader(httpMethod, requestUrl, requestBody) {\r"," // var CLIENT_KEY = 'JohnnyBoy';\r"," var SECRET_KEY = environment.secret_creator;\r"," // var SECRET_KEY = 'Test';\r"," var AUTH_TYPE = 'HMAC-SHA512';\r"," \r"," var requestPath = getPath(requestUrl);\r"," var queryString = getQueryString(requestUrl);\r"," if (httpMethod == 'GET' || !requestBody) {\r"," requestBody = ''; \r"," } else {\r"," //requestBody = JSON.stringify(requestBody);\r"," }\r"," console.log(\"requestBody: \" + requestBody);\r"," \r"," //var hashedPayload = CryptoJS.enc.Hex.stringify(CryptoJS.SHA512(requestBody));\r"," //console.log(\"hashedPayload: \" + hashedPayload);\r"," \r"," //var timestamp = new Date().toISOString().split('.')[0]+\"Z\";\r"," //console.log(\"timestamp: \" + timestamp);\r"," \r"," //var requestData = [httpMethod, requestPath, queryString, timestamp, hashedPayload].join(\"\\n\");\r"," //console.log(\"requestData: \" + requestData);\r"," \r"," //var hashedRequestData = CryptoJS.enc.Hex.stringify(CryptoJS.SHA512(requestData));\r"," //console.log(\"hashedRequestData: \" + hashedRequestData);\r"," \r"," //var hmacDigest = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(hashedRequestData, SECRET_KEY));\r"," var hmacDigest = CryptoJS.HmacSHA512(requestBody, SECRET_KEY);\r"," console.log(\"Signature: \" + hmacDigest);\r"," \r"," return hmacDigest;\r","}\r","\r","postman.setEnvironmentVariable('signature', getAuthHeader(request['method'], request['url'], request['data']));"],"type":"text/javascript"}}],"id":"e7b711cc-0eb0-41ff-9f4a-85ca70558e68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"identifier","type":"text","value":"{{identifier_creator}}"},{"key":"signature","type":"text","value":"{{signature}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"{{transactionId}}\",\n\t\"fromDate\": \"yyyy-MM-dd HH:mm:ss.SSS\",\n\t\"toDate\": \"yyyy-MM-dd HH:mm:ss.SSS\",\n\t\"limit\": \"{{limit}}\",\n\t\"nextPageIndex\": \"{{nextPageIndex}}\",\n\t\"status\": \"{{status}}\"\n}"},"url":"{{protocol}}://{{host}}/api/twod/v1/listCodes","description":"

Returns a list of codes that have been created for a specified period for a specific state/s.

Used by Customer wanting to Pay/Withdraw or Desposit using a 2D Code, call will return the state of that Code.

Used to Pay using a 2D Code

Used to Withdraw using a 2D Code

Used to Deposit using a 2D Code

Before any of these calls can be used the following steps need to be taken on the 2D Controller;

-Ensure that an API Device has been created using this call

{{protocol}}://{{host}}/api/admin/v1/createDevice

-An Account must exist in 2D linking the API device (if a Device Account doesnt exist, one can be create via the Create Account call

{{protocol}}://{{host}}/api/twod/v1/account/create/

\n","_postman_id":"a57ce6e7-efe0-4b7c-8672-7357af89321b","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","id":"fd9142a9-daec-4fc7-9a10-2302ff1e4a1f","name":"TwoDApi","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"a0663aa0-9250-41e5-ab57-99c1507a6c9b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7c2dc43b-0ae1-41d4-b65e-c569ad8f3a68","type":"text/javascript","exec":[""]}}]}