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

PARAMETERDESCRIPTIONMANDATORY
Version String (4)Version of the API. Current version is v1Yes
requestTimestamp String (15)UNIX timestamp of the time request is being sentNo
channelId String (3)For websites, the value is WEB. For Mobile websites/App, the value is WAPYes
txnToken String (64)Provided in response of Create Subscription/ Initiate Transaction APIYes

Body

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

Response Attributes:

API Content format: JSON

Head

PARAMETERDESCRIPTIONMANDATORY
Version String (2)Version of the API passed in the requestYes
responseTimestamp String (15)UNIX Timestamp of the responseYes

Body

PARAMETERDESCRIPTIONMANDATORY
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

ResultInfo

PARAMETERDESCRIPTIONMANDATORY
resultStatusString (S(Success), F(Failure), U(Unknown))Status of API callYes
resultCodestringResult code returned to merchant . Max length of result code can be 64Yes
resultMsgstring (Max length can be 256])Result Message contains information about the result.Yes

balanceInfo JSON Object

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

Response Codes and messages

CODEMESSAGE
1006txnToken sent in request has expired or is invalid
2012ssoToken is invalid.
2013Different mid's sent in initiate transaction request and fetchBalanceInfoRequest
2014Different orderId's sent in initiate transaction request and fetchBalanceInfoRequest
0000Success operation
3003We are unable to fetch your balance, kindly try after sometime
2008We are facing some issue with postpaid, please use other payment options
00000900System error

Endpoints

Staging: https://securegw-stage.paytm.in/theia/api/v1/fetchBalanceInfo?mid=<mid>&orderId=<orderId>

Production: https://securegw.paytm.in/theia/api/v1/fetchBalanceInfo?mid=<mid>&orderId=<orderId>

Request CodeResponse JSON
curl -X POST 'https://securegw-stage.paytm.in/userAsset/fetchBalanceInfo?mid=xxxxxxxxxxxxxxxxxxxx&orderId=xxxxxxxxxxxxxxxx' --header 'Content-Type: application/json' --data '{"body":{"paymentMode":"BALANCE"},"head":{"clientId":"C11","version":"v1","requestTimestamp":1555253298,"channelId":"WEB","txnToken":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}}'