• Getting Started
    • Website Integration
      Mobile Integration (Android/IOS)
      Enterprise Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Webhooks
      Testing
      Refunds
      Guides
      Other Processes

      Fetch Balance Info API

      Checksum required: No

      Use Case


      To get the balance of Paytm Wallet, Paytm Postpaid and Paytm Payments Bank.

      Request Attributes

      API Content format: JSON

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      version String (4)Version of the API. Current version is v1.No
      requestTimestamp String (15)UNIX timestamp of the time request is being sentNo
      channelId String (3)Channel through which call is initiated.
      For websites, the value is WEB.
      For Mobile websites/App, the value is WAP.
      Yes
      txnToken String (64)Unique Transaction Token generated in response of Initiate Transaction API / Initiate Subscription API. Merchant has to send back the same transaction token everytime in each subsequent API Call to communicate with PGYes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      paymentModePaytm payment mode for which you need to fetch balance (BALANCE,PPBL,PAYTM_DIGITAL_CREDIT)Yes

      Response Attributes

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      version String (2)Version of the API passed in the request.No
      responseTimestamp String (15)UNIX Timestamp of the responseYes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      balanceInfo BalanceInfoBalance information of payment modeYes
      resultInfo ResultInfoResult informationYes
      passCodeRequired booleanDenoting if passcode is required for payment through the payment optionNo
      accountStatus Stringaccount statusNo
      enable booleanpay method is enable or notNo
      extraParamsMap Map<String, Object>Map for any Extra informationNo

      BalanceInfo

      ATTRIBUTEDESCRIPTIONMANDATORY
      Value floatTransaction value upto decimal like 100.50Yes
      Currency StringCurrency code (INR)Yes

      ResultInfo

      ATTRIBUTEDESCRIPTIONMANDATORY
      resultCodeStringResult code returned to merchant . Max length of result code can be 64Yes
      resultStatusStringStatus of API call
      (S:Success, F:Failure, U:Unknown)
      Yes
      resultMsg String(256)Result Message contains information about the result.Yes

      Response Codes and messages

      resultCoderesultStatusresultMsg
      0000SSuccess operation
      1006FtxnToken sent in request has expired or is invalid
      2012Fsso Token is invalid.
      2013FDifferent mid's sent in initiate transaction request and fetchBalanceInfoRequest
      2014FDifferent orderId's sent in initiate transaction request and fetchBalanceInfoRequest
      3003FWe are unable to fetch your balance, kindly try after sometime
      2008FWe are facing some issue with postpaid, please use other payment options
      00000900USystem error

      Endpoints

      Staging: https://securegw-stage.paytm.in/userAsset/fetchBalanceInfo?mid={mid}&orderId={order-id}

      Production: https://securegw.paytm.in/userAsset/fetchBalanceInfo?mid={mid}&orderId={order-id}

      Request CodeResponse JSON
      curl -X POST 'https://securegw-stage.paytm.in/userAsset/fetchBalanceInfo?mid={mid}&orderId={order-id}' --header 'Content-Type: application/json' --data '{"head":{"txnToken":"{transaction-token}"},"body":{"paymentMode":"{payment-mode}"}}'