POSTFetch Balance Info API

Use Case

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

Request Attributes

Content Type : JSON

Head

Attribute	Description
version string optional	Version of the API. Example: v1
requestTimestamp string optional	EPOCH timestamp of the time at which request is being sent. Example: 1588402269
channelId string optional	The parameter value identifies the Channel for which API call is initiated. Possible values: WEB For websites, the value to be passed should be "WEB" , WAP For Mobile websites/App, the value to be passed should be "WAP"
txnToken string mandatory	This is the unique transaction token received in the response of Initiate Transaction API or Initiate Subscription API. It is valid for 15 minutes. Example:f0bed899539742309eebd8XXXX7edcf61588842333227

Body

Attribute	Description
paymentMode string mandatory	Paytm payment mode for which you need to fetch balance. Possible values: BALANCE For Paytm Wallet , PPBL For Paytm Payments Bank , PAYTM_DIGITAL_CREDIT For Paytm Postpaid

Response Attributes

Content Type : JSON

Head

Attribute	Description
version string	Version of the API passed in the request. Example: v1
responseTimestamp string	EPOCH timestamp of the time at which response is being sent. Example: 1588402269

Body

Attribute

Description

resultInfo

object

This parameter gives the information about the result of the API response

ResultInfo

Attribute	Description
resultCode string	This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below.
resultStatus string	This parameter indicates the status of API call. Possible Values: S, F, U
resultMsg string	This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below.

balanceInfo

object

Balance information of payment mode

BalanceInfo

Attribute	Description
value string	This parameter contains the amount to be charged to the customer and can have two places of decimal. Example: 1.00
currency string	This parameter indicates the currency in which transaction amount is to be deducted. Possible Values: INR

passCodeRequired

boolean

Denoting if passcode is required for payment through the payment option

accountStatus

string

Account status

Possible Values: Active, Inactive

enable

boolean

pay method is enable or not

extraParamsMap

object

Map for any extra information.

Response Codes & Messages

resultCode	resultStatus	resultMsg
0000	S	Success
1001	S	Depending upon the use case the result message could be one from the following list: Sso Token is blank. Invalid payment mode.
1006	F	txnToken sent in request has expired or is invalid
2004	F	SSO Token is invalid
2008	F	We are facing some issue with postpaid, please use other payment options
2012	F	Operation is not supported
2013	F	Different mid's sent in initiate transaction request and fetchBalanceInfoRequest
2014	F	OrderId in the query param doesn't match with the OrderId send in the request
3003	F	We are unable to fetch your balance, kindly try after sometime
3006	F	OrderId in the query param doesn't match with the OrderId send in the request
00000900	U	System error

⇾

Staging

Production

https://securestage.paytmpayments.com/userAsset/fetchBalanceInfo?mid={mid}&orderId={order-id} copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securestage.paytmpayments.com/userAsset/fetchBalanceInfo?mid={mid}&orderId=ORDERID_98765' \
--header 'Content-Type: application/json' \
--data '{"head":{"txnToken":"f0bed899539742309eebd8XXXX7edcf61588842333227"},"body":{"paymentMode":"BALANCE"}}'