Scribd Logo
Upload

Welcome to Scribd!

  • 132 views

    Recharge API

    Uploaded by

    Biswadeep Sarkar
    This document outlines the API methods for an SMS wallet service. It describes 9 methods for tasks like recharging a mobile number, getting the balance or operator details, checking recharge status, registering a complaint, viewing bills, and doing an IMPS money transfer. Each method requires an API token and returns a response in XML format containing fields like request ID, status, balance, remarks, and error codes.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd

    Recharge API

    Uploaded by

    Biswadeep Sarkar
    132 views5 pages
    This document outlines the API methods for an SMS wallet service. It describes 9 methods for tasks like recharging a mobile number, getting the balance or operator details, checking recharge status, registering a complaint, viewing bills, and doing an IMPS money transfer. Each method requires an API token and returns a response in XML format containing fields like request ID, status, balance, remarks, and error codes.

    Original Description:

    API to Recharge Wallet

    Copyright

    © © All Rights Reserved

    Available Formats

    PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    This document outlines the API methods for an SMS wallet service. It describes 9 methods for tasks like recharging a mobile number, getting the balance or operator details, checking recharge status, registering a complaint, viewing bills, and doing an IMPS money transfer. Each method requires an API token and returns a response in XML format containing fields like request ID, status, balance, remarks, and error codes.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    132 views5 pages

    Recharge API

    Uploaded by

    Biswadeep Sarkar
    This document outlines the API methods for an SMS wallet service. It describes 9 methods for tasks like recharging a mobile number, getting the balance or operator details, checking recharge status, registering a complaint, viewing bills, and doing an IMPS money transfer. Each method requires an API token and returns a response in XML format containing fields like request ID, status, balance, remarks, and error codes.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    of 5

    API DOCUMENT v2.

    5
    Contents
    1. RECHARGE ....................................................................................................................................... 2
    2. RESPONSE PAGE: ............................................................................................................................. 2
    3. ERROR CODES: ................................................................................................................................ 3
    4. GET BALANCE: ................................................................................................................................. 3
    5. GET OPERATOR: .............................................................................................................................. 3
    6. GET STATUS: .................................................................................................................................... 4
    7. REGISTER COMPLAINT: ................................................................................................................... 4
    8. VIEW BILL: ....................................................................................................................................... 4
    9. Money transfer IMPS ...................................................................................................................... 5
    METHODS:
    1. RECHARGE
    url: http://www.smslinkwallet.com/apiservice.asmx/Recharge

    apiToken Generate API Token from API TOKEN page


    mn mobile number to recharge
    op operator code available in MyCommission Page
    amt recharge amount
    reqid unique request id alphanumeric max length 20
    field1 Only in case of BSNL, MTNL LANDLINE send account number
    in field1 else its blank
    field2 Optional field for future reference

    SAMPLE:
    http://www.smslinkwallet.com/apiservice.asmx/Recharge?apiToken=yourapitoken&
    mn=1234567890&op=1&amt=0&reqid=65S4F6S4DF&field1=&field2=

    SUPPORT:HTTP GET OR HTTP POST

    RESPONSE:
    <?xml version="1.0" encoding="utf-8"?>
    <Result xmlns="http://tempuri.org/">
    <reqid>unique id sent by the client</reqid>
    <status>SUCCESS/FAILED/PENDING/FREQUENT</status>
    <remark>recharge summary</remark>
    <balance>balance after recharge</balance>
    <mn>string</mn>
    <field1>operator transaction id</field1>
    <ec>error code</ec>
    </Result>

    2. RESPONSE PAGE:
    Yourresponsepage?reqid=reqid&status=status&remark=remark&balance=balance&
    mn=mn&field1=field1

    reqid Unique request id sent during api request


    status SUCCESS/PENDING/FAILED/REFUND
    remark Recharge summary
    balance Wallet balance after the recharge
    mn Mobile number recharged
    field1 Operator transaction id
    ec Error code
    3. ERROR CODES:
    Error code Error description
    1000 SUCCESS
    1002 LOGIN FAILED
    1003 ACCESS DENIED
    1004 API NOT ASSIGNED
    1005 INVALID MOBILE NUMBER
    1006 INVALID AMOUNT
    1007 DUPLICATE REQID
    1008 NETWORK ERROR
    1009 FREQUENT RECHARGE
    1010 RECHARGE PENDING
    1011 INTERNAL ERROR
    1013 OPERATOR DOWN
    1014 REFUND
    1015 INSUFFICIENT BALANCE
    1016 INSUFFICIENT MINIMUM BALANCE
    1017 REFUND DECLINED

    4. GET BALANCE:
    url: http://www.smslinkwallet.com/apiservice.asmx/GetBalance
    apiToken Generate API Token from API TOKEN page

    SAMPLE:
    http://www.smslinkwallet.com/apiservice.asmx/GetBalance?apiToken=yourapitoke
    n

    5. GET OPERATOR:
    url: http://www.smslinkwallet.com/apiservice.asmx/GetOperator
    mn Mobile Number

    Response:

    <MobileProvider xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://tempuri.org/">
    <code>9819</code>
    <provider>Vodafone India</provider>
    <state>
    Mumbai Metro Telecom Circle (includes Navi Mumbai and Kalyan)
    </state>
    <opid>5</opid>
    </MobileProvider>
    6. GET STATUS:
    url: http://www.smslinkwallet.com/apiservice.asmx/GetRechargeStatus
    apiToken Generate API Token from API TOKEN page
    reqid Unique request id sent during api request

    RESPONSE:
    <?xml version="1.0" encoding="utf-8"?>
    <Result xmlns="http://tempuri.org/">
    <reqid>unique id sent by the client</reqid>
    <status>SUCCESS/FAILED/PENDING/REFUND</status>
    <remark>recharge summary</remark>
    <balance>balance after recharge</balance>
    <mn>string</mn>
    <field1>operator transaction id</field1>
    <ec>error code</ec>
    </Result>

    7. REGISTER COMPLAINT:
    url: http://www.smslinkwallet.com/apiservice.asmx/RegisterComplaint
    apiToken Generate API Token from API TOKEN page
    reqid Unique request id sent during api request

    8. VIEW BILL:
    url: http://www.smslinkwallet.com/ws/viewBill
    apiToken Generate API Token from API TOKEN page
    mn mobile number to recharge
    op operator code available in MyCommission Page
    reqid unique request id alphanumeric max length 20
    field1 Only in case of BSNL, MTNL LANDLINE send account number
    in field1 else its blank
    field2 Optional field for future reference

    Response:
    {"success":true,"data":[{"billAmount":"199.0","dueDate":"20160702","statusMessag
    e":"Bill amount = 199.0, BillDueDate = 02 Jul 2016. Due date has been
    expired","acceptPayment":false,"acceptPartPay":false,"maxBillAmount":""}]}
    9. Money transfer IMPS
    url: http://www.smslinkwallet.com/apiservice.asmx/Recharge

    apiToken Generate API Token from API TOKEN page


    mn Account number of the beneficiary
    op 89
    amt Amount to be transferred
    reqid unique request id alphanumeric max length 20
    field1 IFSC code
    field2 Optional field for future reference

    SAMPLE:
    http://www.smslinkwallet.com/apiservice.asmx/Recharge?apiToken=yourapitoken&
    mn=1234567890&op=89&amt=0&reqid=65S4F6S4DF&field1=IFSC000136&field2=

    SUPPORT:HTTP GET OR HTTP POST

    RESPONSE:
    <?xml version="1.0" encoding="utf-8"?>
    <Result xmlns="http://tempuri.org/">
    <reqid>unique id sent by the client</reqid>
    <status>SUCCESS/FAILED/PENDING</status>
    <remark>Imps summary</remark>
    <balance>balance after Transfer</balance>
    <mn>string</mn>
    <field1>Imps reference number</field1>
    <ec>error code</ec>
    </Result>

    You might also like