The following API endpoints were created to allow partner stores to redeem eVOUCHERs, directly from their websites and they were based on the below workflow:
\nCustomer visits partner store's website
\nCustomer adds one or more products/services to cart
\nCustomer inputs eVOUCHER code (web_scan_voucher_api)
\nCustomer proceeds to payment (web_lock_voucher_api)
\nPayment success (web_redeem_voucher_api)
\nPayment failure (web_unlock_voucher_api)
\nNote: access tokens should always be passed as X-Token in the header.
\nAlways use the correct API method.
\nYour API calls are considered successful, when the success variable has value one (1). If the value is zero (0), the call is considered failed.
\nProceed with necessary actions, if only the response of the API call is successful (1).
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Important Information","slug":"important-information"}],"owner":"33149398","collectionId":"93229a8e-5bb8-49af-a412-c6d3c7d4f994","publishedId":"2sAYdimUQ8","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"11acac"},"publishDate":"2025-03-02T10:51:50.000Z"},"item":[{"name":"Web Scan Voucher","id":"b7265f13-587a-4e6a-95b3-23ccfe0bedda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"web_bill_total\": 10,\t\t //Customer’s bill total\n \"voucher_code\": \"12345678\",\t\t\t//Voucher code\n \"machine_name\": \"{{machine_name}}\"\t//Token name\n}","options":{"raw":{"language":"json"}}},"url":"https://evoucher.cy/index.php?route=account/web_scan_voucher_api","description":"The web_scan_voucher_api is triggered when a user enters a voucher code to check its validity before proceeding with payment. It verifies the voucher's status (e.g., active, expired, redeemed) without locking or reserving it, allowing multiple scans without restricting usage. We respond with the maximum available amount that can be redeemed using this code.
Note: the session ID is required by the rest of the endpoints and it is valid for 5 minutes. If the user does not proceed to payment within 5 minutes, he must apply the code again to get a new session ID.
\n","urlObject":{"protocol":"https","path":["index.php"],"host":["evoucher.cy"],"query":[{"key":"route","value":"account/web_scan_voucher_api"}],"variable":[]}},"response":[{"id":"3f6a8982-d58b-4120-9170-544804fc809c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"web_bill_total\": 10,\n \"voucher_code\": \"12345678\",\n \"machine_name\": \"{{machine_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://evoucher.cy/index.php?route=account/web_scan_voucher_api","protocol":"https","host":["evoucher.cy"],"path":["index.php"],"query":[{"key":"route","value":"account/web_scan_voucher_api"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 07 Mar 2025 00:33:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-CE","value":"b6h2"},{"key":"Set-Cookie","value":"OCSESSID=4599602858f7324a9cda823e50; path=/"},{"key":"X-Httpd","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-CDN-C","value":"static"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-SG-CDN","value":"1"},{"key":"X-Proxy-Cache-Info","value":"DT:1"},{"key":"Host-Header","value":"8441280b0c35cbc1147f8ba998a563a7"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"price\": \"10.00\",\n \"session_id\": \"41ef9f6e5b3e4fc1b45d6fc7b236bc60\",\n \"message\": \"The voucher is valid. Please complete the payment within 5 minutes!\"\n}"},{"id":"29361fdb-c2c0-4ce5-b3e9-dcf59dbb012a","name":"Wrong code","originalRequest":{"method":"POST","header":[{"key":"X-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"web_bill_total\": 10,\t\t //Customer’s bill total\n \"voucher_code\": \"12345678\",\t\t\t//Voucher code\n \"machine_name\": \"{{machine_name}}\"\t//Token name\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://evoucher.cy/index.php?route=account/web_scan_voucher_api","protocol":"https","host":["evoucher.cy"],"path":["index.php"],"query":[{"key":"route","value":"account/web_scan_voucher_api"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 13 Apr 2025 16:17:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-CE","value":"8krx"},{"key":"Set-Cookie","value":"OCSESSID=fb4401036621038d436cf5e6c9; path=/"},{"key":"X-Httpd","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-CDN-C","value":"static"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-SG-CDN","value":"1"},{"key":"X-Proxy-Cache-Info","value":"DT:1"},{"key":"Host-Header","value":"8441280b0c35cbc1147f8ba998a563a7"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 0,\n \"message\": \"Voucher with code 12345678 does not exist!\"\n}"},{"id":"f18a6b58-9155-4fd7-b4a8-d7866410aa7a","name":"Already redeemed","originalRequest":{"method":"POST","header":[{"key":"X-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"web_bill_total\": 10,\t\t //Customer’s bill total\n \"voucher_code\": \"12345678\",\t\t\t//Voucher code\n \"machine_name\": \"{{machine_name}}\"\t//Token name\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://evoucher.cy/index.php?route=account/web_scan_voucher_api","protocol":"https","host":["evoucher.cy"],"path":["index.php"],"query":[{"key":"route","value":"account/web_scan_voucher_api"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 13 Apr 2025 16:16:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-CE","value":"qkt1"},{"key":"Set-Cookie","value":"OCSESSID=fb4401036621038d436cf5e6c9; path=/"},{"key":"X-Httpd","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-CDN-C","value":"static"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-SG-CDN","value":"1"},{"key":"X-Proxy-Cache-Info","value":"DT:1"},{"key":"Host-Header","value":"8441280b0c35cbc1147f8ba998a563a7"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 0,\n \"message\": \"Voucher with code 12345678 has already been redeemed\"\n}"},{"id":"bf667f3c-9219-44ad-9250-a0d720a0ce3d","name":"Expired voucher","originalRequest":{"method":"POST","header":[{"key":"X-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"web_bill_total\": 10,\n \"voucher_code\": \"12345678\",\n \"machine_name\": \"{{machine_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://evoucher.cy/index.php?route=account/web_scan_voucher_api","protocol":"https","host":["evoucher.cy"],"path":["index.php"],"query":[{"key":"route","value":"account/web_scan_voucher_api"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 02 Mar 2025 10:34:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-CE","value":"b6h2"},{"key":"Set-Cookie","value":"OCSESSID=539c5abc88a5a93d476bf3283e; path=/"},{"key":"X-Httpd","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-CDN-C","value":"static"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-SG-CDN","value":"1"},{"key":"X-Proxy-Cache-Info","value":"DT:1"},{"key":"Host-Header","value":"8441280b0c35cbc1147f8ba998a563a7"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 0,\n \"message\": \"Voucher with code 12345678 expired on 03-12-2024.\"\n}"},{"id":"668cc24d-0e45-48e5-93ea-be2240876f20","name":"Voucher not eligible for redemption","originalRequest":{"method":"POST","header":[{"key":"X-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"web_bill_total\": 10,\t\t //Customer’s bill total\n \"voucher_code\": \"12345678\",\t\t\t//Voucher code\n \"machine_name\": \"{{machine_name}}\"\t//Token name\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://evoucher.cy/index.php?route=account/web_scan_voucher_api","protocol":"https","host":["evoucher.cy"],"path":["index.php"],"query":[{"key":"route","value":"account/web_scan_voucher_api"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 13 Apr 2025 17:27:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-CE","value":"qkt1"},{"key":"Set-Cookie","value":"OCSESSID=fb4401036621038d436cf5e6c9; path=/"},{"key":"X-Httpd","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-CDN-C","value":"static"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-SG-CDN","value":"1"},{"key":"X-Proxy-Cache-Info","value":"DT:1"},{"key":"Host-Header","value":"8441280b0c35cbc1147f8ba998a563a7"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 0,\n \"message\": \"Voucher with code 12345678 cannot be redeemed, as the order status is not eligible for redemption!\"\n}"},{"id":"9de3b636-e5fa-42f9-8179-ab7a1262d5dd","name":"Store not allowed to redeem","originalRequest":{"method":"POST","header":[{"key":"X-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"web_bill_total\": 10,\n \"voucher_code\": \"12345678\",\n \"machine_name\": \"{{machine_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://evoucher.cy/index.php?route=account/web_scan_voucher_api","protocol":"https","host":["evoucher.cy"],"path":["index.php"],"query":[{"key":"route","value":"account/web_scan_voucher_api"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 02 Mar 2025 10:33:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-CE","value":"b6h2"},{"key":"Set-Cookie","value":"OCSESSID=539c5abc88a5a93d476bf3283e; path=/"},{"key":"X-Httpd","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-CDN-C","value":"static"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-SG-CDN","value":"1"},{"key":"X-Proxy-Cache-Info","value":"DT:1"},{"key":"Host-Header","value":"8441280b0c35cbc1147f8ba998a563a7"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 0,\n \"message\": \"Voucher with code 12345678 cannot be redeemed at your store!\" //Trying to scan voucher of store A to store B\n}"}],"_postman_id":"b7265f13-587a-4e6a-95b3-23ccfe0bedda"},{"name":"Web Lock Voucher","id":"3f55d110-20a4-4332-b50a-8d2a8d0d6a57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"session_id\": \"e9df467fc3a11927e9239d101ebb0021\",\r\n \"voucher_code\": \"12345678\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://evoucher.cy/index.php?route=account/web_lock_voucher_api","description":"The web_lock_voucher_api is triggered when a user clicks “Proceed to Payment.” It temporarily locks the voucher for a short duration (5 minutes) to prevent others from using it during the checkout process, ensuring that the voucher is reserved for the current transaction.
The web_redeem_voucher_api is triggered after a successful payment to deduct the specified amount from the voucher's balance. If there is remaining balance, the voucher can be used again in future transactions until fully consumed.
The web_lock_voucher_api is triggered when a voucher that was previously locked during the payment process needs to be released due to a failed, canceled, or timed-out payment. Its purpose is to remove the lock on the voucher so it can be reused, ensuring that vouchers are not held unnecessarily and remain available for future redemption attempts.