6
Recharge API Integration Document API URL : http://www.api.excelmultirecharge.in/reseller/reseller_login.php Each API is IP Restricted You need to provide your server ip to integrate this api. Mobile & DTH Recharge API Input URL: …/reseller/FlexiRechargeAPI.php Parameters: reseller_id=<Your ResellerID>&reseller_pass=<Your Reseller Pass>&denomination=<Recharge Amount>&mobilenumber=<Mobile Number>&operatorid=<Operator Id>&meroid=<Your System Generated Order/ Id>&circleid=<Circle Id>&voucher=<Voucher Type if Specified> Request Parameters Data Type Description reseller_id Numeric Your reseller id as provided by us. reseller_pass Alpha-Numeric API Password as provided by Us. denomination Numeric Amount for which mobile is to be recharged mobilenumber Numeric Mobile that is to be recharged operatorid Numeric Operator id as provided by Us for each mobile / dth operators meroid Numeric Your System generated Orderid circleid Numeric Or ‘*’ ‘*’ stands for all circles and Other Numeric Specified as per List provided by Us. voucher Text Default : blank Example: voucher= Should be Provided as per Operator’s Usage mernotes Text [ Optional ] Optional Parameter Specify any description related to this Recharge

API Documentation

Embed Size (px)

DESCRIPTION

The documentation of the API

Citation preview

  • Recharge API

    Integration Document

    API

    URL : http://www.api.excelmultirecharge.in/reseller/reseller_login.php

    Each API is IP Restricted You need to provide your server ip to integrate this api.

    Mobile & DTH Recharge API

    Input URL: /reseller/FlexiRechargeAPI.php

    Parameters:

    reseller_id=&reseller_pass=&denomination=&mobilenumber=&operatorid=&meroid=&circleid=&voucher=

    Request Parameters Data Type Description

    reseller_id Numeric Your reseller id as provided by

    us.

    reseller_pass Alpha-Numeric API Password as provided by

    Us.

    denomination Numeric Amount for which mobile is to

    be recharged

    mobilenumber Numeric Mobile that is to be recharged

    operatorid Numeric Operator id as provided by Us

    for each mobile / dth operators

    meroid Numeric Your System generated Orderid

    circleid Numeric Or * * stands for all circles and

    Other Numeric Specified as per

    List provided by Us.

    voucher Text

    Default : blank

    Example:

    voucher=

    Should be Provided as per

    Operators Usage

    mernotes Text [ Optional ] Optional Parameter

    Specify any description

    related to this Recharge

  • List of operators with Operator ID

    Operator Name Operator Id DOCOMO TOPUP 1

    AIRTEL 2

    IDEA 3

    AIRCEL 4

    RELIANCE GSM 7

    VODAFONE 9

    BSNL TOPUP 10

    RELIANCE CDMA 20

    BSNL SPECIAL 25

    UNINOR TOPUP 26

    UNINOR SPECIAL 31

    DOCOMO SPECIAL 39

  • Mobile Recharge API

    Output:

    API Output Parameters in Xml Format

    Response

    Parameter

    Data Type Description

    Status Text Recharge Status

    TalkTime Numeric Float TalkTime Provided by

    operator to customer

    OperatorTxnId Alpha-Numeric Operator Provided

    Transaction Id

    Description Text Recharge status

    Description

    OrderId Numeric our System generated

    Orderid

    MerOid Numeric Your System

    Generated OrderId

    Mobile Numeric Mobile Recharged

    Denomination Numeric Amount Recharged

    MerNotes Text [Optional] Optional Parameter

    Specify any

    description

    related to this

    Recharge

    CreditUsed Numeric Float Amount Deducted for

    successful recharge

    done

    Balance Numeric Float Your Balance After

    Recharge

    Example: SUCCESS Recharge FAILED Recharge

    SUCCESS 0 GU0012337209 Transaction Successful 1234600 4133 967123456 10 9.808 9999999726.88

    FAILED 0 # Do Not Use The Same Number in 5 Minute Interval 1234603 9900215485 10 4136 Test Recharge 9.808 9.808 9999999707.26

    Merchant Order Id already

    Exists in system

  • Recharge Status API

    Method: GET

    URL:

    /reseller/RechargeStatusAPI.php

    Params:

    reseller_id=&reseller_pass=&orderid=&meroid=

    API Input Parameters as Web URL Get Method

    Request Parameter Data Type Desc.

    reseller_id Numeric Your Reseller id

    Generated and given

    by us.

    reseller_pass Alpha-Numeric Your Reseller API

    password

    orderid Numeric Alliance generated

    Orderid

    meroid Numeric Your System

    Generated OrderId

    Output

    API Output Parameters in Xml Format

    Response

    Parameter

    Data Type Desc.

    OrderId Numeric Alliance generated

    Orderid

    MerOid Numeric Your System

    Generated OrderId

    Mobile Numeric Mobile Recharged

    Denomination Numeric Amount Recharged

    Status Text Recharge Status

    OperatorTxnId Alpha-Numeric Operator Provided

    Transaction Id

    Description Text Recharge status

    Description

    Output in Xml Format:

    non-Error Output Error OUTPUT

    4137

    4133

    9912326545

    10

    SUCCESS

    GU00

    Transaction

    Successful

    Invalid Reseller

    Details

  • Reseller Balance API

    Method: GET

    URL: /reseller/ResellerBalanceAPI.php

    Parameters: reseller_id=&reseller_pass=

    Request Parameters Data Type Description

    reseller_id Numeric Your Reseller id provided by us.

    reseller_pass Alpha-Numeric Your API Password

    Output:

    Response Parameters Data Type Description

    Balance Float Your available balance with us.

    Error Text Available only if Error is

    Generated.

    Non-Error Output Error Output

    9999999707.26

    Invalid Reseller Details

  • Reseller Operators API (Get List of Operator Enabled for Me)

    Method: GET

    URL: /reseller/ResellerOperatorsAPI.php

    Parameters: reseller_id=&reseller_pass=

    Request Parameters Data Type Description

    reseller_id Numeric Your Reseller id provided by us.

    reseller_pass Alpha-Numeric Your API Password

    Output:

    Response Parameters Data Type Description

    OperatorId Integer Our System Generated

    Operator Id, which you need to

    Provide when you trigger

    Operator based Queries, or

    When you Trigger Recharge API

    OperatorName Text This Fields Specify Operator

    Name, which is Displayed to

    Educate you which Id stands

    for which Operator in our

    System.

    Non-Error Output Error Output

    1 Reliance

    2 Idea

    3 Vodafone

    4 LOOP Mobile

    Invalid Reseller Details