search

POSTFetch Balance API

Use Case

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

Request Attributes

Content Type : JSON

Head

AttributeDescription
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

AttributeDescription
mid
string
mandatory

Super 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.

paymentMode
string
mandatory

Payment mode for which you need to fetch balance.
 

Possible values: PPBL, PAYMENT_DIGITAL_CREDIT, WALLET

walletType
string
conditional

Type of wallet for which balance needs to be fetched 
 

Possible values: PAYTM (required only when paymentMode = WALLET)

Response Attributes

Content Type : JSON

Head

AttributeDescription
version
string

Version of the API passed in the request.
 

Example: v1, v2, v5

responseTimestamp
string

EPOCH timestamp of the time at which response is being sent. 

 

Example: 1588402269

Body

AttributeDescription
balanceInfo
Object

Balance information of payment mode.

BalanceInfo
+
AttributeDescription
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

fullTnCDetails
Object

TnC Details

fullTnCDetails
+
AttributeDescription
message
string

TnC message

link
string

TnC Link

linkMessage
string

Message  Link

enable
boolean

Pay method is enabled or not.

detailedBalanceInfos
List <detailedBalanceInfos>

Detailed Balance Info

DetailedBalanceInfo
+
AttributeDescription
balanceInfo
string

Balance information

templateId
string

Template ID

templateName
string

Template Name

iconUrl
string

Icon URL

monthlySanctionLimit
BalanceInfo

Monthly Sanction Limit

BalanceInfo
+
AttributeDescription
subWalletDetails
array of object

Basic details of Paytm sub wallet

SubWalletDetails
+
AttributeDescription
displayName
string

Paytm sub wallet name

Example: Paytm Wallet

balance
string

Paytm sub wallet balance

Example: 2.00

imageUrl
string

Paytm sub wallet icon

payerAccountExists
boolean

Status of Paytm Wallet

accountBalance
object

Total balance of Paytm wallet

Money
+
AttributeDescription
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

monthlyAvailableSanctionLimit
BalanceInfo

Monthly Available Sanction Limit

BalanceInfo
+
AttributeDescription
subWalletDetails
array of object

Basic details of Paytm sub wallet

SubWalletDetails
+
AttributeDescription
displayName
string

Paytm sub wallet name

Example: Paytm Wallet

balance
string

Paytm sub wallet balance

Example: 2.00

imageUrl
string

Paytm sub wallet icon

payerAccountExists
boolean

Status of Paytm Wallet

accountBalance
object

Total balance of Paytm wallet

Money
+
AttributeDescription
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

partnerBankBalances
List<BankPartnerDetail>

Partner Bank Detailed

BankPartnerDetail
+
AttributeDescription
interestEarned
double

Interest Earned

balance
double

Balance

name
string

Name

resultInfo
Object

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

resultInfo
+
AttributeDescription
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.

extraParamsMap
Map<String, String>

Map for any extra information.

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
501FSystem error
1006FInvalid token or session expired
2006FMid is invalid
2012FOrderId is invalid
Staging
Production
https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchBalance?mid={mid}&orderId={orderID}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET

Wallet

curl --location --request POST 'https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchBalance' \
--header 'Content-Type: application/json' \
--data-raw '{"head": {"requestTimestamp": "1655466060","channelId": "WEB","token": "59475303-f784-40b1-81c0-23218d7c790a","tokenType": "TXN_TOKEN"},"body": {"mid": "YOUR_MID_HERE","orderId": "STAG_900494","paymentMode": "WALLET","walletType":"PAYTM"}}'

 

copy icon