{"info":{"_postman_id":"a6d37cb4-0c39-2980-735a-68b30759f105","name":"Paygrt API","description":"

$\"Paygrt$

Paygrt is one of the leading payments service provider in country.

We provide APIs specially designed as per market need. Our API is suitable for Recharges (Mobile and DTH), Bill Payments (Postpaid, Landline, Gas, Electricity, Water etc) & Cash Drop Solutions (Home Credit, Swiggy Money, Bajaj Finserv etc). Paygrt's API is built on REST framework which supports json/xml formats enabling it to be easily integrated by the developers.

Authentication

All API requests must be authenticated with an api-key in the request. Your API Key is the most important thing, so keep it secure!

Think of your api-key like a password:

Store it securely
Don't share it with anyone outside of your organization
Don't put it in any code on your website or in a Url that someone could find

You authenticate to the Paygrt API by providing your API key in the header of each request.

Platform Credentials

You can use following values for testing Recharge and Bill Payment APIs:

base-url: api.paygrt.com
api-key: YT9wJw00W9FC+4y9InszizshzbuibCLqMVtnGzpTQhp5SdFBLetOU==
merchant_id: AP1743

\n
Partners will be provided unique api-key and merchant_id after onboarding to Paygrt's platform.
\n

Questions/Comments/Suggestions

If you have any questions or comments, please let us know at support@paygrt.com.

Error Codes

For all API requests, status=0 should be treated as successfull else fail. Status of the transaction can be retrieved from status_code parameter.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	Description
0	Success
1	Fail

Possible values of parameter status_code

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status_code	Description
0	Success
1	Fail
2	Pending

\n
For status_code=1, failure reason can be retrieved from message parameter.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Platform Credentials","slug":"platform-credentials"},{"content":"Questions/Comments/Suggestions","slug":"questionscommentssuggestions"},{"content":"Error Codes","slug":"error-codes"}],"owner":"5931055","collectionId":"a6d37cb4-0c39-2980-735a-68b30759f105","publishedId":"RzZFBbSG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"01A185"},"publishDate":"2018-11-20T13:36:37.000Z"},"item":[{"name":"Recharge and Bill Payment","item":[{"name":"Balance Check","id":"b8d19c88-7e8f-4da7-b8cd-05a89e4483e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","description":"

Your unique API key that will authenticate your request

\n"}],"url":"https://{{base-url}}/v1/merchants/{{merchant_id}}/balance","description":"

This API will return merchant's available balance.

\n","urlObject":{"protocol":"https","path":["v1","merchants","{{merchant_id}}","balance"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"47c4ff9b-03b4-d99b-39ec-0cd4f7130331","name":"Balance Check","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","description":"Your unique API key that will authenticate your request"}],"url":"https://{{base-url}}/v1/merchants/{{merchant_id}}/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"content-length","key":"content-length","value":"120","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Tue, 20 Nov 2018 13:12:13 GMT","description":""},{"name":"expires","key":"expires","value":"-1","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"Microsoft-IIS/7.5","description":""},{"name":"x-aspnet-version","key":"x-aspnet-version","value":"4.0.30319","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"ASP.NET","description":""},{"name":"x-powered-by-plesk","key":"x-powered-by-plesk","value":"PleskWin","description":""}],"cookie":[],"responseTime":"2642","body":"{\"message\":\"Success\",\"data\":{\"merchant_id\":\"AP1743\",\"merchant_name\":\"API Partner Demo\",\"balance\":\"0.0000\"},\"status\":\"0\"}"}],"_postman_id":"b8d19c88-7e8f-4da7-b8cd-05a89e4483e6"},{"name":"Operators List","id":"c6a2035f-3ade-47c2-95d0-3019e0c5bd4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","description":"

Your unique API key that will authenticate your request

\n"}],"url":"https://{{base-url}}/v1/operators/{{merchant_id}}","description":"

This API will return list of available operators along with their codes.

\n","urlObject":{"protocol":"https","path":["v1","operators","{{merchant_id}}"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"c59f677f-5483-dc57-3147-915949e94a52","name":"Operators List","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","description":"Your unique API key that will authenticate your request"}],"url":"https://{{base-url}}/v1/operators/{{merchant_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"content-length","key":"content-length","value":"1543","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Sun, 14 Apr 2019 05:25:51 GMT","description":""},{"name":"expires","key":"expires","value":"-1","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"Microsoft-IIS/7.5","description":""},{"name":"x-aspnet-version","key":"x-aspnet-version","value":"4.0.30319","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"ASP.NET","description":""},{"name":"x-powered-by-plesk","key":"x-powered-by-plesk","value":"PleskWin","description":""}],"cookie":[],"responseTime":"995","body":"{\n \"message\": \"Success\",\n \"data\": [\n {\n \"operator_name\": \"Home Credit\",\n \"operator_code\": \"HC\",\n \"type\": \"Cash Drop\"\n },\n {\n \"operator_name\": \"Swiggy\",\n \"operator_code\": \"SW\",\n \"type\": \"Cash Drop\"\n },\n {\n \"operator_name\": \"Bajaj Finserv\",\n \"operator_code\": \"BFC\",\n \"type\": \"Cash Drop\"\n },\n {\n \"operator_name\": \"Airtel\",\n \"operator_code\": \"AT\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"BSNL Special\",\n \"operator_code\": \"BS\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"BSNL Top Up\",\n \"operator_code\": \"BT\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"Idea\",\n \"operator_code\": \"ID\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"MTNL Special\",\n \"operator_code\": \"MS\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"MTNL Top Up\",\n \"operator_code\": \"TM\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"Reliance Jio\",\n \"operator_code\": \"RJ\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"Tata Docomo Special\",\n \"operator_code\": \"DS\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"Tata Docomo Top Up\",\n \"operator_code\": \"DT\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"Tata Indicom/ CDMA\",\n \"operator_code\": \"TI\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"Uninor Special\",\n \"operator_code\": \"US\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"Uninor Top Up\",\n \"operator_code\": \"UT\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"Vodafone\",\n \"operator_code\": \"VF\",\n \"type\": \"Mobile\"\n },\n {\n \"operator_name\": \"Airtel DTH\",\n \"operator_code\": \"AH\",\n \"type\": \"DTH\"\n },\n {\n \"operator_name\": \"BIG TV\",\n \"operator_code\": \"BG\",\n \"type\": \"DTH\"\n },\n {\n \"operator_name\": \"Dish TV\",\n \"operator_code\": \"DH\",\n \"type\": \"DTH\"\n },\n {\n \"operator_name\": \"Sun Direct\",\n \"operator_code\": \"SD\",\n \"type\": \"DTH\"\n },\n {\n \"operator_name\": \"Tata Sky\",\n \"operator_code\": \"TS\",\n \"type\": \"DTH\"\n },\n {\n \"operator_name\": \"Videocon D2h\",\n \"operator_code\": \"VD\",\n \"type\": \"DTH\"\n }\n ],\n \"status\": \"0\"\n}"}],"_postman_id":"c6a2035f-3ade-47c2-95d0-3019e0c5bd4d"},{"name":"Recharge","id":"70b3c3a9-5b25-224d-bba4-36b7169bff7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","description":"

Your unique API key that will authenticate your request

\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_ref_id","value":"1120","description":"

Merchant's unique transaction reference id

\n","type":"text"},{"key":"recharge_number","value":"9988998899","description":"

Recharge Number

\n","type":"text"},{"key":"recharge_amount","value":"10","description":"

Recharge Amount

\n","type":"text"},{"key":"operator_code","value":"AT","description":"

Operator code as provided in Operator List API

\n","type":"text"}]},"url":"https://{{base-url}}/v1/recharges/{{merchant_id}}","description":"

This API is used to process recharge and bill payments.

Under UAT environments, only Airtel(AT) operator's recharges will have static Success response. For all other operators, Fail response will be returned.

\n","urlObject":{"protocol":"https","path":["v1","recharges","{{merchant_id}}"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"23bce542-d0c1-429b-3bf3-d90b42c39b51","name":"Recharge Submitted","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","description":"Your unique API key that will authenticate your request"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_ref_id","value":"12345","type":"text"},{"key":"recharge_number","value":"9988998899","type":"text"},{"key":"recharge_amount","value":"10","type":"text"},{"key":"operator_code","value":"AT","type":"text"}]},"url":"https://{{base-url}}/v1/recharges/{{merchant_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"content-length","key":"content-length","value":"277","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Wed, 21 Nov 2018 11:29:45 GMT","description":""},{"name":"expires","key":"expires","value":"-1","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"Microsoft-IIS/7.5","description":""},{"name":"x-aspnet-version","key":"x-aspnet-version","value":"4.0.30319","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"ASP.NET","description":""},{"name":"x-powered-by-plesk","key":"x-powered-by-plesk","value":"PleskWin","description":""}],"cookie":[],"responseTime":"1903","body":"{\n \"message\": \"Success\",\n \"data\": {\n \"api_ref_id\": \"12345\",\n \"txn_id\": \"5001234\",\n \"operator_id\": \"\",\n \"recharge_number\": \"9988998899\",\n \"recharge_amount\": \"10.00\",\n \"recharge_status\": \"Pending\",\n \"message\": \"Recharge Request Accepted\",\n \"remaining_balance\": \"12150.50\",\n \"status_code\": \"2\"\n },\n \"status\": \"0\"\n}\n"},{"id":"c50bffdf-1d82-318e-61f0-29a39300c044","name":"Recharge Fail","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","description":"Your unique API key that will authenticate your request"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_ref_id","value":"12346","description":"Merchant's unique transaction reference id","type":"text"},{"key":"recharge_number","value":"9988998899","description":"Recharge Number","type":"text"},{"key":"recharge_amount","value":"399","description":"Recharge Amount","type":"text"},{"key":"operator_code","value":"VF","description":"Operator code as provided in Operator List API","type":"text"}]},"url":"https://{{base-url}}/v1/recharges/{{merchant_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"content-length","key":"content-length","value":"254","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Wed, 21 Nov 2018 11:33:20 GMT","description":""},{"name":"expires","key":"expires","value":"-1","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"Microsoft-IIS/7.5","description":""},{"name":"x-aspnet-version","key":"x-aspnet-version","value":"4.0.30319","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"ASP.NET","description":""},{"name":"x-powered-by-plesk","key":"x-powered-by-plesk","value":"PleskWin","description":""}],"cookie":[],"responseTime":"595","body":"{\n \"message\": \"Fail\",\n \"data\": {\n \"api_ref_id\": \"12346\",\n \"txn_id\": null,\n \"operator_id\": null,\n \"recharge_number\": null,\n \"recharge_amount\": null,\n \"recharge_status\": null,\n \"message\": \"Insufficient Merchant Balance\",\n \"remaining_balance\": \"120.00\",\n \"status_code\": \"1\"\n },\n \"status\": \"1\"\n}"}],"_postman_id":"70b3c3a9-5b25-224d-bba4-36b7169bff7b"},{"name":"Callback","id":"df71b2aa-db06-6f6f-44c5-bad4ff642c9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://xyz.com/callback?api_ref_id={{api_ref_id}}&txn_id={{txn_id}}&operator_id={{operator_id}}&recharge_status={{recharge_status}}","description":"

Paygrt will hit partner's Callback URL to update the status of transactions.

API partners can update their Callback URL from the provided panel only after on-boarding.

Possible values for recharge_status will be Success/Pending/Fail.

\n","urlObject":{"protocol":"https","path":["callback"],"host":["xyz","com"],"query":[{"description":{"content":"

Merchant's unique transaction reference id provided earlier in the recharge request

\n","type":"text/plain"},"key":"api_ref_id","value":"{{api_ref_id}}"},{"description":{"content":"

Paygrt's unique transaction id

\n","type":"text/plain"},"key":"txn_id","value":"{{txn_id}}"},{"description":{"content":"

Operator id for the transaction

\n","type":"text/plain"},"key":"operator_id","value":"{{operator_id}}"},{"description":{"content":"

Status of the transaction

\n","type":"text/plain"},"key":"recharge_status","value":"{{recharge_status}}"}],"variable":[]}},"response":[],"_postman_id":"df71b2aa-db06-6f6f-44c5-bad4ff642c9f"},{"name":"Status Check","id":"a36e3b7b-d40b-94ad-173c-ee1cfd131532","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","description":"

Your unique API key that will authenticate your request

\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_ref_id","value":"12345","description":"

Merchant's unique transaction reference id

\n","type":"text"},{"key":"txn_date","value":"2019-07-20","description":"

Transaction date in \"yyyy-mm-dd\" format only

\n","type":"text"}]},"url":"https://{{base-url}}/v1/recharges/status/{{merchant_id}}","description":"

This API is used to check status of the transaction.

Possible values for recharge_status will be Success/Pending/Fail.

\n","urlObject":{"protocol":"https","path":["v1","recharges","status","{{merchant_id}}"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"c797be79-c88a-74de-225e-8164c8b0f84d","name":"Status Check","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","description":"Your unique API key that will authenticate your request"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_ref_id","value":"1120","description":"Merchant's unique transaction reference id","type":"text"},{"key":"txn_date","value":"2019-07-20","description":"Transaction date in \"yyyy-mm-dd\" format only","type":"text"}]},"url":"https://{{base-url}}/v1/recharges/status/{{merchant_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"content-length","key":"content-length","value":"132","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Mon, 15 Apr 2019 07:51:12 GMT","description":""},{"name":"expires","key":"expires","value":"-1","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"Microsoft-IIS/10.0","description":""},{"name":"x-aspnet-version","key":"x-aspnet-version","value":"4.0.30319","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"ASP.NET","description":""},{"name":"x-sourcefiles","key":"x-sourcefiles","value":"=?UTF-8?B?RDpcVlNQcm9qZWN0c1xQYXlncnRXZWJBUElcUGF5Z3J0QVBJXHYxXHJlY2hhcmdlc1xzdGF0dXNcQVAxNzQz?=","description":""}],"cookie":[],"responseTime":"1454","body":"{\n \"message\": \"Success\",\n \"data\": {\n \"api_ref_id\": \"12345\",\n \"txn_id\": \"5001234\",\n \"operator_id\": \"PG12345XYZ\",\n \"recharge_status\": \"Success\"\n },\n \"status\": \"0\"\n}"}],"_postman_id":"a36e3b7b-d40b-94ad-173c-ee1cfd131532"}],"id":"536d7e49-2429-822a-b238-921c17be20d3","description":"

Recharge and Bill Payment API

\n","_postman_id":"536d7e49-2429-822a-b238-921c17be20d3"}]}