apiscript developer private limited · postpaid airtel pa postpaid idea pi postpaid vodafone pv...

APISCRIPT DEVELOPER PRIVATE LIMITED

1 | P a g e The information contained in this document is proprietary property of APIScript Developer Private Limited. Unauthorized viewing, printing or reproduction is prohibited.

API Document

API stands for Application Programming Integration which is widely used to integrate and

enable interaction with other software, much in the same way as a user interface facilitates

interaction between humans and computers. Our API codes can be easily integrated to any

web or software application.

You can start your own Mobile Recharge, DTH Recharge, Postpaid Mobile, Electric

Bill, Landline Bill, GAS Bill, Water Bill, Broadband Bill, Insurance Bill.

API Services List

• Mobile Recharge

• DTH Recharge

• Postpaid Mobile

• Electric Bill

• Landline Bill

• GAS Bill

• Water Bill

• Broadband Bill

• Insurance Bill

• Account Balance

• Bill Verification

• Transaction Status

Operator List

• Mobile Operator

• DTH Operator

• Postpaid Operator

• Electric Bill Operator

• Landline Bill Operator

• GAS Bill Operator

• Water Bill Operator

• Broadband Bill Operator

• Insurance Bill Operator



Parameter is used for API Request

Parameter Name Description

username Required - User Name for API Access

pwd Required - Password for API Access

operatorcode Required - Operator Code for Services (See List of Operator

Code)

number Required - Mobile Number/ DTH Number to Recharge

amount Required - Amount for transaction to recharge

account Optional Parameter (Used for Electric, Landline, GAS, Insurance,

Water, Broadband)

auth Optional Parameter (Used for Electric, Landline, GAS, Insurance,

Water, Broadband)

bill_verify_id Optional Parameter (Used for Electric, Landline, GAS, Insurance,

Water, Broadband)

client_id Required - Your Unique Transaction ID (Only Number Accept)

token Required - Every API request. It is use for security purpose. Check

how token parameter is passed.



Common API Request Format Prepaid Mobile, DTH TV, Post Paid Mobile

Recharge API Request

URL For Staging: http://staging.apiscript.in/recharge/api

Post Data:

username=your_username&pwd=your_password&operatorcode=MA&number=7070645987

&amount=10&client_id=100&token=EncryptTokenValue

Response:

{"message":"Your recharge request is accepted.","recharge_id":2,"recharge_status":"Pending",

"amount":"10","number":"7070645987","client_id":"100","recharge_datetime":

"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:

{"message":"Paramenter is missing.","error_code":"1"}



Transaction Status

URL For Staging: http:// staging.apiscript.in/recharge/status

Post Data:

username=your_username&pwd=your_password&recharge_id=2&token=EncryptTokenValue

or

username=your_username&pwd=your_password&client_id=100&token=EncryptTokenValue

API Response for Success:

{"message":"Record

found","amount":"10.00","number":"9898598985","recharge_id":"2","client_id":"100","recharge_st

atus":"Pending","operator_code":"NA","recharge_datetime":"2018-06-28 10:55:26

PM","error_code":"0"}

API Response for Error:


Call back URL

Call back URL: http://www.yourdomainname.com/callback.php

Post Data:

data=%7B%22message%22%3A%22Record+found%22%2C%22amount%22%3A%2210.00%22

%2C%22number%22%3A%229898598985%22%2C%22recharge_id%22%3A%222%22%2C%22

client_id%22%3A%22100%22%2C%22recharge_status%22%3A%22Pending%22%2C%22

operator_code%22%3A%22NA%22%2C%22recharge_datetime%22%3A%222018-06-

28+10%3A55%3A26+PM%22%2C%22error_code%22%3A%220%22%7D

data Parameter is in URL Encode Format.

For Update Call Back URL Response, Mail us [email protected]



Bill Payment

There are two Step in Bill Payment

1. Check Bill

URL for Staging: http://staging.apiscript.in/recharge/check_bill

2. Payment Bill

URL for Staging: http:// staging.apiscript.in/recharge/api

Response for Verification false:

{"message":" Either no bill pending/ due date has passed/ invalid

biller","is_verify":"false","bill_number":"","bill_date":"","bill_due_date":"",

"outstanding_bill_amount":"","partial_bill":"","customer_name":"","verify_ref_id":2,

"error_code":"0"}

Response for Verification true:

{"message":" Success","is_verify":"true","bill_number":"","bill_date":"","bill_due_date":"",

"outstanding_bill_amount":"","partial_bill":"","customer_name":"","verify_ref_id":2,

"error_code":"0"}

Response for Error:


Account Balance

URL For Staging: http://staging.apiscript.in/account/balance

Post Data: username=your_username&pwd=your_password&token=EncryptTokenValue

Response for Success:

{"message":"Success","balance":"1001.25","error_code":"0"}

Response for Error:




Mobile Operator Name Code

AIRTEL MA

AIRTEL* MAL

IDEA MI

IDEA* MIL

VODAFONE MV

VODAFONE* MVL

BSNL TOPUP MBT

BSNL STV MBS

BSNL TOPUP* MBTL

BSNL STV* MBSL

AIRCEL MAC

AIRCEL* MACL

DOCOMO MD

DOCOMO SPECIAL MDS

DOCOMO* MDL

DOCOMO SPECIAL* MDSL

MTNL TOPUP MMT

MTNL STV MMS

JIO MJ

JIO* MJL

TATA INDICOM MTI

DTH Operator Name Operator Code

AIRTEL DIGITAL TV DAD

AIRTEL DIGITAL TV* DADL

DISH TV DD

DISH TV* DDL

TATA SKY DTS

VIDEOCON D2H DVD

SUN DIRECT DS

BIG TV DB



Postpaid Operator Name Operator Code

POSTPAID AIRTEL PA

POSTPAID IDEA PI

POSTPAID VODAFONE PV

POSTPAID TATA TELE SERVICE PT

POSTPAID BSNL PB

POSTPAID DOCOMO PD

POSTPAID AIRCEL PAC

POSTPAID JIO PJ

Landline Operator Name Operator Code

AIRTEL LANDLINE LA

BSNL LANDLINE LB

MTNL DELHI LANDLINE LMD

MTNL MUMBAI LANDLINE LMM

GAS Operator Name Operator Code

ADANI GAS GA

AAVANTIKA GAS LTD GAGL

GUJARAT GAS COMPANY LIMITED GGCL

HARYANA CITY GAS GHC

INDRAPRAST GAS LIMITED GI

MAHANAGAR GAS LIMITED GM

SABARMATI GAS LIMITED GS

SITI ENERGY GSE

TRIPURA NATURAL GAS COMPANY LTD GTN

VADODARA GAS LIMITED GV

CENTRAL UP GAS GCUP

CHAROTAR GAS SAHAKARI MANDALI LIMITED GCGSML

INDIAN OIL ADANI GAS PVT LTD GIOAGPL

GAIL GAS LIMITED GGGL

IRM ENERGY PRIVATE LIMITED GIRMEPL



Electric Operator Name Operator Code

ASSAM POWER DISTRIBUTION COMPANY LTD - NON RAPDR EAPDCN

ASSAM POWER DISTRIBUTION COMPANY LTD - RAPDR EAPDCR

BANGALORE ELECTRICITY SUPPLY COMPANY EBESC

BHARATPUR ELECTRICITY SERVICES LTD EBESL

BIKANER ELECTRICITY SUPPLY LIMITED EBKESL

BRIHAN MUMBAI ELECTRIC SUPPLY AND TRANSPORT UNDERTAKING EBMEST

BSES RAJDHANI EBR

BSES YAMUNA EBY

CALCUTTA ELECTRICITY SUPPLY LTD ECESL

CHAMUNDESHWARI ELECTRICITY SUPPLY CORP LTD ECESCL

CHHATTISGARH STATE ELECTRICITY BOARD ECSEB

DAKSHIN HARYANA BIJLI VITRAN NIGAM EDHBVN

DAMAN AND DIU ELECTRICITY DEPARTMENT EDDED

DNH POWER DISTRIBUTION COMPANY LIMITED EDPDCL

GULBARGA ELECTRICITY SUPPLY COMPANY LIMITED EGESCL

HUBLI ELECTRICITY SUPPLY COMPANY LTD EHESCL

INDIA POWER CORPORATION LIMITED - BIHAR EIPCLB

INDIA POWER CORPORATION - WEST BENGAL EIPCWB

JAIPUR AND AJMER VIYUT VITRAN NIGAM EJAVVN

JAMSHEDPUR UTILITIES AND SERVICES COMPANY LIMITED EJUSCL

JHARKHAND BIJLI VITRAN NIGAM LIMITED EJBVNL

JODHPUR VIDYUT VITRAN NIGAM - JDVVNL EJVVNJ

JODHPUR VIDYUT VITRAN NIGAM LTD EJVVNL

KOTA ELECTRICITY DISTRIBUTION LTD EKEDL

MADHYA PRADESH MADHYA KSHETRA VIDYUT VITARAN COMPANY

LIMITED

EMPMKVVC

MADHYA PRADESH PASCHIM KSHETRA VIDYUT VITARAN JABALPUR EMMPKVVJ

MEGHALAYA POWER DISTRIBUTION CORPORATION LTD EMPDDCL

MSEDC LIMITED EML

NOIDA POWER COMPANY LIMITED ENDPCL

NORTH BIHAR POWER DISTRIBUTION COMPANY LTD ENBPDCL

NORTH DELHI POWER LIMITED ENDPL



ODISHA DISCOMS EOD

PUNJAB STATE POWER CORPORATION LTD EPSPCL

RAJASTHAN VIDYUT VITRAN NIGAM LIMITED ERVVNL

SNDL NAGPUR ESN

SOUTH BIHAR POWER DISTRIBUTION COMPANY LTD ESBPDCL

TAMIL NADU ELECTRICITY BOARD ETEB

TATA POWER MUMBAI ETPM

TORRENT POWER ETP

TRIPURA STATE ELECTRICITY CORPORATION LTD ETSECL

UTTAR PRADESH POWER CORP LTD - RURAL EUPPCLR

UTTAR PRADESH POWER CORP LTD - URBAN EUPPCLU

UTTARAKHAND POWER CORPORATION LIMITED EUPPCL

NEW DELHI MUNICIPAL COUNCIL -NDMC ENDMC

HIMACHAL PRADESH STATE ELECTRICITY EHPSE

DEPARTMENT OF POWER NAGALAND EDPNA

ENERGY AND POWER DEPARTMENT GOVERNMENT OF SIKKIM POWER

RAPDR

EEPDGKP

KANPUR ELECTRICITY SUPPLY COMPANY LTD EKESCL

MANGALORE ELECTRICITY SUPPLY COMPANY LTD EMESCL

SIKKIM POWER NON RAPDRP ESPNR

GOA ELECTRICITY DEPARTMENT EGED

KERALA STATE ELECTRICITY BOARD LTD EKSEBL

MP MADHYA KSHETRA VIDYUT VITARAN BHOPAL RURAL EMMKVVBR

MP POORV KSHETRA VIDYUT VITARAN COMPANY LIMITED JABALPUR

NON RAPDR

EMPKVVCLJNR

WEST BENGAL STATE ELECTRICITY DISTRIBUTION COMPANY LIMITED EWBSEDCL



Insurance Operator Name Operator Code

BHARTI AXA LIFE INSURANCE IBAL

ICICI PRU LIFE IIPL

INDIA FIRST LIFE INSURANCE IIFL

TATA AIG LIFE ITAL

Water Operator Name Operator Code

DELHI JAL BOARD WDLB

MUNICIPAL CORPORATION OF GURUGRAM WMCG

UIT BHIWADI WUB

UTTARAKHAND JAL SANSTHAN WUJS

BANGALORE WATER SUPPLY AND SEWERAGE BOARD WBWSSB

BHOPAL MUNICIPAL CORPORATION WBMC

NEW DELHI MUNICIPAL COUNCIL - NDMC WNDMC

GWALIOR MUNICIPAL CORPORATION WGMC

INDORE MUNICIPAL CORPORATION WIMC

JABALPUR MUNICIPAL CORPORATION WJMC

LUDHIANA MUNICIPAL CORPORATION WLMC

MUNICIPAL CORPORATION OF JALANDHAR WMCOJ

HYDERABAD METROPOLITAN WATER SUPPLY AND SEWERAGE

BOARD

WHMWSSB

GREATER WARANGAL MUNICIPAL CORPORATION WATER WGWMC

MUNICIPAL CORPORATION OF AMRITSAR WMCA

RANCHI MUNICIPAL CORPORATION WRMC

SILVASSA MUNICIPAL COUNCIL WSMC

UJJAIN NAGAR NIGAM PHED WUNNP

SURAT MUNCIPAL CORPORATION WATER WSMCW



Broadband Operator Name Operator Code

CONNECT BROADBAND BCB

HATHWAY BROADBAND BHB

TIKONA POSTPAID BTP

NEXTRA BROADBAND BNEXT

SPECTRANET BROADBAND BSPECT

TTN BROADBAND BTNT



Landline Bill Payment Parameter Format

1. Airtel Landline

Check Bill URL for Staging: http://staging.apiscript.in/recharge/check_bill

Post Data:

username=your_username&pwd=your_password&operatorcode=LA&number=022603258744

&amount=100&token=EncryptTokenValue

Payment URL for Staging: http://staging.apiscript.in/recharge/api

Post Data:

username=your_username&pwd=your_password&operatorcode=LA&number=022603258744

&amount=100&bill_verify_id=12&client_id=100&token=EncryptTokenValue

number: 11 digits along with STD Code




"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:


2. BSNL Landline


Post Data:

username=your_username&pwd=your_password&operatorcode=LB&number=22603258744

&amount=100&auth=LLI&account=10521548798&token=EncryptTokenValue




Post Data:

username=your_username&pwd=your_password&operatorcode=LB&number=22603258744

&amount=100&auth=LLI&account=10521548798&bill_verify_id=12&client_id=100

&token=EncryptTokenValue

number: Landline Number along with STD Code excluding starting 0

account: Account Number 10 Digit

auth: Two possible values 3 Digit. 1) LLI 2) LLC



"amount":"100","number":"22603258744", "client_id":"100","recharge_datetime":

"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:


3. MTNL DELHI LANDLINE AND MTNL MUMBAI LANDLINE


Post Data:

username=your_username&pwd=your_password&operatorcode=LMD&number=603258744

&account=1025456245&amount=100&token=EncryptTokenValue


Post Data:

username=your_username&pwd=your_password&operatorcode=LMD&number=603258744

&account=1025456245&bill_verify_id=12&amount=100&client_id=100&

token=EncryptTokenValue



number: Only Landline Number 8 Digit

account: Account Number 10 Digit




"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:




GAS Bill Payment Parameter Format

1. MAHANAGR GAS LIMITED


Post Data:

username=your_username&pwd=your_password&operatorcode=GM&number=212603258744

&account=23451234&amount=100&token=EncryptTokenValue


Post Data:

username=your_username&pwd=your_password&operatorcode=GM&number=212603258744

&account=23451234&amount=100&bill_verify_id=12&client_id=100&token=EncryptTokenValue

number: CA Number 12 digits starts with 21

account: Bill Group Number 1-8 Digit




"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:


2. ADANI GAS, GUJARAT GAS COMPANY LIMITED, HARYANA CITY GAS, INDRAPRAST

GAS LIMITED, SABARMATI GAS LIMITED, SITI ENERGY, TRIPURA NATURAL GAS

COMPANY LTD, VADODARA GAS LIMITED AND OTHER GAS BILL OPERATOR




Post Data:

username=your_username&pwd=your_password&operatorcode=GA&number=2260325874

&amount=100


Post Data:

username=your_username&pwd=your_password&operatorcode=GA&number=2260325874

&amount=100&bill_verify_id=12&client_id=100




"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:




Electric Bill Payment Parameter Format

1. DAKSHIN HARYANA BIJLI VITRAN NIGAM


Post Data:

username=your_username&pwd=your_password&operatorcode=EDHBVN

&number=212603258&account=7070654789&amount=100&token=EncryptTokenValue


Post Data:

username=your_username&pwd=your_password&operatorcode=EDHBVN&

number=212603258&account=7070654789&bill_verify_id=12&amount=100&

client_id=100&token=EncryptTokenValue

number: Account Number 9-12 digits + characters

account: Mobile Number 10 Digit


{"message":"Your recharge request is

accepted.","recharge_id":2,"recharge_status":"Pending","amount":"100","number":"212603258",

"client_id":"100","recharge_datetime":"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:


2. JHARKHAND BIJLI VITRAN NIGAM LIMITED


Post Data: username=your_username&pwd=your_password&operatorcode=EJBVNL&

number=212603258&account=500&amount=100&token=EncryptTokenValue




Post Data:

username=your_username&pwd=your_password&operatorcode=EJBVNL&

number=212603258&account=500&amount=100&bill_verify_id=12&


number: Consumer Number 3-15 digits + characters

account: Subdivision Code 1-3 Digit




"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:


3. MSEDC LIMITED


Post Data:

username=your_username&pwd=your_password&operatorcode=EML&

number=124514545784&account=4515&auth=02& amount=100&token=EncryptTokenValue


Post Data:

username=your_username&pwd=your_password&operatorcode=EML&

number=124514545784&account=4515&auth=02&bill_verify_id=12&amount=100&




number: Consumer Number 12 digits

account: Billing Unit 4 Digit

auth: Processing Cycle 2 Digit




"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:


4. TATA POWER - MUMBAI


Post Data:

username=your_username&pwd=your_password&operatorcode=ETPM&

number=124514545&account=Mumbai&amount=100&token=EncryptTokenValue


Post Data:

username=your_username&pwd=your_password&operatorcode=ETPM&

number=124514545&account=Mumbai&amount=100&bill_verify_id=12&


number: CA Number 12 digits

account: City Name

Possible values for account parameter: Ahmedabad, Surat, Bhiwandi, Agra, Mumbai




"2018-06-28 10:55:26 PM","error_code":"0"}



Response for Error:


5. TORRENT POWER


Post Data:

username=your_username&pwd=your_password&operatorcode=ETP&

number=654558&account=Ahmedabad&amount=100&token=EncryptTokenValue


Post Data:

username=your_username&pwd=your_password&operatorcode=ETP&

number=654558&account=Ahmedabad&amount=100&bill_verify_id=12&


number: Service Number 1-15 digits

account: City Name (Ahmedabad, Surat, Bhiwandi, Agra)


{"message":"Your recharge request is

accepted.","recharge_id":2,"recharge_status":"Pending","amount":"100","number":"654558",

"client_id":"100","recharge_datetime":"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:


6. ALL Other Biller Parameter

Check URL for Staging: http://staging.apiscript.in/recharge/check_bill

Post Data: username=your_username&pwd=your_password&operatorcode=EREM&

number=5412457846&amount=100&token=EncryptTokenValue




Post Data:

username=your_username&pwd=your_password&operatorcode=EREM&

number=5412457846&amount=100&bill_verify_id=12&client_id=100&token=EncryptTokenValue

number: Bill Number




"2018-06-28 10:55:26 PM","error_code":"0"}

Response for Error:




Water Bill Payment Parameter Format

1. DELHI JAL BOARD, MUNICIPAL CORPORATION OF GURUGRAM, UIT BHIWADI,

UTTARAKHAND JAL SANSTHAN AND OTHER BILL OPERATOR


Post Data:

username=your_username&pwd=your_password&operatorcode=WDLB&



Post Data:

username=your_username&pwd=your_password&operatorcode=WDLB&

number=212603258744&amount=100&bill_verify_id=12&client_id=100&


number: CA Number 12 digits starts with 21




"2018-06-28 10:55:26 PM","error_code":"0"}

2. MUNICIPAL CORPORATION OF AMRITSAR


Post Data:

username=your_username&pwd=your_password&operatorcode=WMCA&

number=212603258&amount=100&account=9898598985&auth=12BILL

&token=EncryptTokenValue




Post Data:

username=your_username&pwd=your_password&operatorcode=WMCA&

number=212603258&amount=100&account=9898598985&auth=12BILL&

bill_verify_id=12&client_id=100&token=EncryptTokenValue

number: Account Number 1-9 digits

account: Consumer Mobile Number 10 Digit

auth: UID 1-16 Alphanumeric


{"message":"Your recharge request is accepted.","recharge_id":2,"recharge_status":"Pending"

,"amount":"100","number":"212603258744","client_id":"100","recharge_datetime":

"2018-06-28 10:55:26 PM","error_code":"0"}



Broadband Bill Payment Parameter Format

1. CONNECT BROADBAND, HATHWAY BROADBAND, TIKONA POSTPAID


Post Data:

username=your_username&pwd=your_password&operatorcode=BCB&



Post Data:

username=your_username&pwd=your_password&operatorcode=BCB&






"2018-06-28 10:55:26 PM","error_code":"0"}



Insurance Bill Payment Parameter Format

1. TATA AIG LIFE, ICICI PRU LIFE


Post Data:

username=your_username&pwd=your_password&operatorcode=IIPL&

number=212603258&account=01-09-1989&amount=100&token=EncryptTokenValue


Post Data:

username=your_username&pwd=your_password&operatorcode=IIPL&

number=212603258&account=01-09-1989&amount=100&bill_verify_id=12&


number: Policy Number

account: Date of Birth (DD-MM-YYYY)




"2018-06-28 10:55:26 PM","error_code":"0"}

2. BHARTI AXA LIFE INSURANCE, INDIA FIRST LIFE INSURANCE


Post Data:

username=your_username&pwd=your_password&operatorcode=IBAL&





Post Data:

username=your_username&pwd=your_password&operatorcode=IBAL&



number: Policy Number




"2018-06-28 10:55:26 PM","error_code":"0"}

JWT Encode

URL for Staging: http://staging.apiscript.in/jwt_encode

Post Data:

secret_key=4836-5cbc25d9d9412-716470&[email protected]


{"encode_token":"eyJ0eXAiOiJK.V1QiLCJhbGciOiJIUzI1NiJ9.IntcIlRpbWVTdGFt","error_code":"0"}

Response for Error:




API Token Generate

In Every API Request Send Encrypt Token Using Algorithm HS256

Refer http://jwt.io/#debugger or Use JWT Encode URL

Token Format: {"TimeStamp":"1536488914","EmailID":"[email protected]"}

You need three Parameter for generate token:

1) Time Stamp => Current Time Stamp

2) Email ID => Your Register Email ID.

3) Secret Key => Share by us via Email.

Sample Code in PHP:

require_once 'php-jwt-master/vendor/autoload.php';

use \Firebase\JWT\JWT;

public function get_encode_token($token,$secret_key) {

return JWT::encode($token, $secret_key);

}

public function get_decode_token($token,$secret_key) {

return JWT::decode($token, $secret_key, array('HS256'));

}

$date = new DateTime();

$time = $date->getTimestamp();

$email_id = ‘[email protected]’;

$secret_key = ‘MySecretKey’;

$token = $this->get_encode_token('{"TimeStamp":"' . $time . '","EmailID":$email_id}',

$secret_key); // Pass this token value in every API Request

Sample Output Token Value:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.IntcIlRpbWVTdGFtcFwiOlwiMTUzNjQ5MDkxMVw

iLFwiRW1haWxJRFwiOlwiaW5mb0BhcGlzY3JpcHQuaW5cIn0i.DrTCpQ5mclAU12md_E-

o25gALZz1Sm17CMz_sOjqcL8

http://jwt.io/#debugger

apiscript developer private limited · postpaid airtel pa postpaid idea pi postpaid vodafone pv...

Documents