{"info":{"_postman_id":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","name":"Payelio Payment API Documentation (old )","description":"

Overview

This API will allow Switching Partners and Till Point Service Partners to integrate our Payment Solution seamlessly and without hassle.

Authentication

The Authentication method is a API Key that expires in 1200 seconds. This give the customer enough time to scan the QR code or enter the unique code generated by the system to transact.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"}],"owner":"15795792","collectionId":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","publishedId":"TzkyNL89","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-06-30T12:30:33.000Z"},"item":[{"name":"Authorization","item":[{"name":"Get Authentication Key","id":"32eb346d-9846-42dd-90e5-f604857fca66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"client-id","value":"78454f8f-32c6-46de-91fb-046ca5144b8c","type":"text","description":"

The client ID you received when linking a merchant

\n"},{"key":"client-secret","value":"S3ZkFtR81fh5AEVmqOLW4gXPdzbe9vUj","type":"text","description":"

The client secret you received when linking a merchant

\n"},{"key":"grant-type","value":"create_orders","type":"text","description":"

The grant type to be used.

\n"},{"key":"scope","value":"ip_credentials","description":"

Scope of the API call.

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://secure.payelio.com/v2/api/authorize","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","id":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","name":"Payelio Payment API Documentation (old )","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","api","authorize"],"host":["secure","payelio","com"],"query":[],"variable":[]}},"response":[{"id":"45f80550-c8f4-4c49-af53-2d12763e9172","name":"Success","originalRequest":{"method":"POST","header":[{"key":"client-id","value":"35814250","type":"text"},{"key":"client-secret","value":"coSZlBCid1wjHI0N7PTpGy2RQxXsgekU","type":"text"},{"key":"grant-type","value":"create_order","type":"text"},{"key":"scope","value":"ip_credentials","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://secure.payelio.com/v2/api/authorize"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": {\n \"access_token\": \"MzNmYWRhYzAzZTdkZTZhMDE2ODY1NzQyNGRhMTlmMjg1MmJjOThiMGQ0YjM0ZGViMTYyMTM1MjI5MQ==\",\n \"expires_in\": 1200,\n \"grant_type\": \"create_order\"\n }\n}"},{"id":"df374cac-2998-428f-8cd2-e6883693eb20","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"client-id","value":"35814250","type":"text"},{"key":"client-secret","value":"coSZlBCid1wjHI0N7PTpGy2RQxXsgekU","type":"text"},{"key":"grant-type","value":"create_order","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://secure.payelio.com/v2/api/authorize"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"messages\": \"Not Authorized\"\n}"}],"_postman_id":"32eb346d-9846-42dd-90e5-f604857fca66"}],"id":"de07384e-769e-4d97-a013-0bda5fff3740","_postman_id":"de07384e-769e-4d97-a013-0bda5fff3740","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","id":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","name":"Payelio Payment API Documentation (old )","type":"collection"}}},{"name":"Create eCommerce Orders","item":[{"name":"Post eCommerce","id":"9dfc6721-aa35-45a9-a7d2-080d4579751d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"description\" : \"\",\n \"order_reference\" : \"1234\",\n \"total_amount\" : \"2.50\",\n \"merchant_id\" : \"387095\",\n \"site_id\" : \"89059\",\n \"notify_url\" : \"https://yourdomain.com/notify\",\n \"type\" : \"strict\",\n \"redirect_url\" : \"https://www.yourdomain.com/notification/redirect_page\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://secure.payelio.com/v2/ecommerce","description":"

Notify URL

The notify_url allows the eCommerce platform to receive notification of where the Transaction Process is. Transaction notifications are sent for the following:

NEW
PENDING
PROCESSING
COMPLETED
FAILED
ABANDONED

\n\n

Redirect URL

The redirect_url will be set on the secure transacting page. This will allow the customer to be redirected to your desired Thank You Page after the completion of the Purchase:

The Redirect URL will be appended with a status parameter. the Parameter will either state:

COMPLETED
FAILED
ABANDONED

for example:

https://www.yourdomain.com/notification/redirect_page?status=COMPLETED

\n","urlObject":{"protocol":"https","path":["v2","ecommerce"],"host":["secure","payelio","com"],"query":[],"variable":[]}},"response":[{"id":"3a1800b9-7ced-43d2-a24c-c255e1b6c242","name":"200","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ZTMzNTg5NTYxNTVhMGU2Yjk2N2NkN2M4MzU4MzJhMmMyNjcwYmMwMDM4NzRiN2ViMTYyMTQzNzg3OQ==","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\" = \"\",\n \"order_reference\" = \"1234\",\n \"total_amount\" = \"2.50\",\n \"merchant_id\" = 387095,\n \"site_id\" = \"89059\",\n \"notify_url\" = \"https://secure.loyaltypay.mobi/v2/api/notify\",\n \"type\" => \"strict\",\n \"redirect_url\" = \"https://secure.loyaltypay.mobi/v2/apitest/postEcommerce\",\n}\n{\n\n}\n"},"url":"https://secure.payelio.com/v2/ecommerce/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"messages\": \"Success\",\n \"data\": {\n \"redirectUri\": \"https://secure.payelio.com/ecommerce/payment?s=0859324671\"\n }\n}"}],"_postman_id":"9dfc6721-aa35-45a9-a7d2-080d4579751d"}],"id":"3304b46e-6ae1-4ae4-b592-39490b238620","_postman_id":"3304b46e-6ae1-4ae4-b592-39490b238620","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","id":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","name":"Payelio Payment API Documentation (old )","type":"collection"}}},{"name":"Create New Transactions","item":[{"name":"Create Order","id":"c82db052-1045-4290-8bc1-77f72cadf733","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"This is a ref\",\n \"order_reference\": \"32456785912\",\n \"total_amount\": \"5.00\",\n \"merchant_id\": \"215902\",\n \"site_id\": \"12345\",\n \"notification_url\": \"https://secure.sb.loyaltypay.mobi/api/notify\",\n \"type\": \"strict\"\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.payelio.com/v2/orders","description":"

Notify URL

\n\n

The notify_url allows the Speedpoint Processor or Till Point platform to receive notification of where the Transaction Process is. Transaction notifications are sent for the following:

NEW
PENDING
PROCESSING
COMPLETED
FAILED
ABANDONED

","urlObject":{"protocol":"https","path":["v2","orders"],"host":["secure","payelio","com"],"query":[],"variable":[]}},"response":[{"id":"f9596d6e-ad33-4390-aeba-de0237832898","name":"success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ZTNhNGZkYjM3NWM2NDQ0ODU2ZmY4MWI4OWE3ZTE2ZWQwYmFkNjdjZGQyM2NmZDJhMTYyMTQ0MDA3NQ==","description":"Authorization key received from the Auth API Call","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"This is a ref\",\n \"order_reference\": \"32456785912\",\n \"total_amount\": \"5.00\",\n \"merchant_id\": \"215897\",\n \"site_id\": \"1234\",\n \"notification_url\": \"https://secure.sb.loyaltypay.mobi/api/notify\",\n \"type\": \"strict\"\n}","options":{"raw":{"language":"json"}}},"url":"{{orders_url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 May 2021 16:03:52 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Content-Length","value":"67"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": {\n \"qr_code\": \"6973104852\"\n }\n}"}],"_postman_id":"c82db052-1045-4290-8bc1-77f72cadf733"},{"name":"Get Order","id":"404fc3fb-1b72-42f9-91f7-56e9ff4a6335","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://secure.payelio.com/v2/orders?order_reference=32456785912","urlObject":{"protocol":"https","path":["v2","orders"],"host":["secure","payelio","com"],"query":[{"key":"order_reference","value":"32456785912"}],"variable":[]}},"response":[{"id":"bd002bbd-886b-4b51-927a-c85065c39621","name":"401","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"NjRlMWU3M2Q0YWUxYmJjZTQ2MGIzNjUzNjhlMWE0NTNiODI4MGI5MWRmOWE0NDA4MTYyMTQzODQ5OA==","type":"text"}],"url":{"raw":"https://secure.payelio.com/v2/orders?external_reference=32456785912","protocol":"https","host":["secure","payelio","com"],"path":["v2","orders"],"query":[{"key":"external_reference","value":"32456785912"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 401,\n \"messages\": \"No order reference number has been specified.\"\n}"},{"id":"8ed3314b-23d3-446d-b71f-ba5b3760d258","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"NjRlMWU3M2Q0YWUxYmJjZTQ2MGIzNjUzNjhlMWE0NTNiODI4MGI5MWRmOWE0NDA4MTYyMTQzODQ5OA==","type":"text"}],"url":{"raw":"https://secure.payelio.com/v2/orders?external_reference=32456785912","protocol":"https","host":["secure","payelio","com"],"path":["v2","orders"],"query":[{"key":"external_reference","value":"32456785912"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": {\n \"order\": {\n \"order_id\": \"p4egqjbPOlIARNvi\",\n \"order_reference\": \"32456785912\",\n \"description\": \"This is a ref\",\n \"merchant_id\": \"387095\",\n \"site_id\": \"89059\",\n \"currency_code\": \"ZAR\",\n \"total_amount\": \"10\",\n \"notify_url\": \"https://secure.loyaltypay.mobi/api/notify\",\n \"created\": \"2021-05-19 17:43:13\"\n },\n \"status\": \"NEW\"\n }\n}"}],"_postman_id":"404fc3fb-1b72-42f9-91f7-56e9ff4a6335"}],"id":"59e93f72-c0fa-4314-b553-2380866678b4","_postman_id":"59e93f72-c0fa-4314-b553-2380866678b4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","id":"f340bb87-6fab-428d-a7d6-0b91649b9dc8","name":"Payelio Payment API Documentation (old )","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"1dcca624-4c8e-4d2a-b16c-62b87296e75d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d94ad268-6842-413c-b4ce-6159ecb22c04","type":"text/javascript","exec":[""]}}]}