POSTFetch Balance API

Use Case

To get the balance of Paytm Wallet and Paytm Postpaid.

Request Attributes

Content Type : JSON

Head

Attribute	Description
requestTimeStamp string optional	Request time in mili-seconds.
channelId string optional	The parameter value identifies the Channel for which the API call is initiated.Default value will be WEB. Possible values: WEB , WAP, APP, SYSTEM
token string mandatory	This is the unique transaction token Example: ede0b9a1-e30d-4fa0-89fb-68221c3e9ff6
tokenType string mandatory	Token Type, Values that can be selected: TXN_TOKEN

Body

Attribute

Description

mid

string

mandatory

AI router provides MID as a unique identifier to each merchant.

Example: 216820000002516036253

orderId

string

mandatory

The Unique reference ID of the Order. It is alphanumeric and the max length is 50 characters.

Example: AOA001115.

payOptions

List<PayOptions>

mandatory

Payment options for which you need to fetch balance.

payOptions

Attribute	Description
payMethod string mandatory	Paytm payment mode for which you need to fetch the balance. Possible values: PAYMENT_DIGITAL_CREDIT, WALLET
issuer string mandatory	Issuer name Possible Value: PAYTM

Response Attributes

Content Type : JSON

Head

Attribute	Description
requestTimeStamp string	Request time in mili-seconds.

Body

Attribute

Description

wallet

List<BalanceInfoResponseDetails>

Wallet balance

BalanceInfoResponseDetails

Attribute

Description

issuer

string

Name of the Instrument Issuer
Possible Value: PAYTM

balanceInfo

object

Balance information of payment options.

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 the transaction amount is to be deducted. Possible Values: INR

fundSufficient

Boolean

If the Balance is sufficient to complete the transaction the value will be true or else false

accountStatus

string

Account status
Possible Values: NOT_ACTIVE, DEACTIVE, ACTIVE, FROZEN, ON_HOLD

monthlySanctionLimit

object

Monthly sanction limit for the account

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 the transaction amount is to be deducted. Possible Values: INR

monthlyAvailableSanctionLimit

object

Monthly available limit from the total monthly sanctioned limit available

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 the transaction amount is to be deducted. Possible Values: INR

errorCode

string

Error code in case of an error or an exception

errorMessage

string

Error message in case of an error or an exception

bnpl

List<BalanceInfoResponseDetails>

Pay later / Postpaid Instruments balance

BalanceInfoResponseDetails

Attribute

Description

issuer

string

Name of the Instrument Issuer
Possible Value: PAYTM

balanceInfo

object

Balance information of payment options.

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 the transaction amount is to be deducted. Possible Values: INR

fundSufficient

Boolean

If the Balance is sufficient to complete the transaction the value will be true or else false

accountStatus

string

Account status
Possible Values: NOT_ACTIVE, DEACTIVE, ACTIVE, FROZEN, ON_HOLD

monthlySanctionLimit

object

Monthly sanction limit for the account

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 the transaction amount is to be deducted. Possible Values: INR

monthlyAvailableSanctionLimit

object

Monthly available limit from the total monthly sanctioned limit available

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 the transaction amount is to be deducted. Possible Values: INR

errorCode

string

Error code in case of an error or an exception

errorMessage

string

Error message in case of an error or an exception

resultInfo

Object

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

resultInfo

Attribute	Description
resultStatus string	This parameter is the result specific to the phase of the transaction mentioned in the txnType field
resultCode string	This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64.
resultMsg string	This parameter is the result message which contains information about the result.

Response Codes & Messages

resultCode	resultStatus	resultMsg
0000	S	Success
501	F	System error
1006	F	Your Session has expired
2006	F	Mid is invalid
2012	F	OrderId is invalid
2222	F	Invalid request body
1011	F	Invalid {field name} For example: Invalid tokenType/ issuer/ payMode, etc
2016	F	We are unable to fetch your balance, kindly try after sometime
2017	F	Issuer cannot be blank or Null
2018	F	Invalid sso token
2019	F	Token type cannot be blank or null
2020	F	Txn token cannot be blank or null

⇾

Staging

Production

https://stage-router.paytm.in/aoa-pay-option-service/v3/fetchBalance copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl --location 'https://stage-router.paytm.in/aoa-pay-option-service/v3/fetchBalance' \
--header 'Content-Type: application/json' \
--data '{"head": {"requestTimestamp": "1655466060","channelId": "WEB","token": "59475303-f784-40b1-81c0-23218d7c790a","tokenType": "TXN_TOKEN"},"body": {"mid": "Your_MID_Here","orderId": "STAG_900494","payOptions": [{"payMethod": "WALLET","issuer": "PAYTM"},{"payMethod": "PAYTM_DIGITAL_CREDIT","issuer": "PAYTM"}]}}