Paytm data API: endpoints behind the wallet & passbook
Paytm, built by Noida-based One97 Communications, is the super-app that brought mobile payments into everyday Indian life: it launched in 2010 as a prepaid mobile and DTH recharge service, surged with its wallet during the 2016 demonetisation, and now competes with PhonePe and Google Pay for UPI payments. Users scan a merchant's QR code or pay a contact over UPI, approving each payment with their UPI PIN; open the wallet landing to see the Paytm Wallet balance next to food-wallet and gift-voucher sub-wallets and their Paytm Payments Bank savings balance; and scroll the passbook and spend-analytics screens to trace where every rupee went. Beyond payments it handles mobile and DTH recharges, electricity and other utility bills, FASTag, and flight, train and movie ticket bookings, while kirana stores and other small merchants use it to accept QR payments, hear each one announced on a Paytm Soundbox, and track their settlements. Built for the Indian market, it holds a 4.4 rating across 10 million Google Play ratings.
Passbook rows log every wallet and bank movement one line at a time: a txnId and txnStatus, the txnamount in its currencyCode, the payModeName and a txnCategory such as P2P, a free-text narration, the txnFrom and txnTo counterparties with their payeeId and payerId, the qrId behind a scan-to-pay, a walletOrderId, the txnPostDate, itemized feeDetails and an extendedTxnInfo block.
Balance reads return accountBalance.value and accountBalance.currency with a per-sub-wallet subWalletDetails breakdown, partnerBankBalances, redeemableInvestmentBalance, a payerAccountExists flag and the minTransactionAmount / maxTransactionAmount limits for a single payment. The sub-wallet list tells the main wallet, food wallet and gift vouchers apart by subWalletName, displayName and walletType, each with its accountNumber, issuedOn and expiry dates. A UPI collect returns its payeeVpa, payeeName, amount and txnNote, an approvalFlow such as MPC_PIN, and a status that stays PENDING until the bank authorises the payment.
Money managers pull wallet and savings balances together with the passbook history into one net-worth view, categorizing spend by payModeName and narration. Sellers reconcile settlements line by line — txnId, amount, feeDetails, counterparty — matching wallet credits against their own order ledger. ERP workflows initiate UPI collect requests straight from an overdue-invoice list, with payee name, amount and note pre-filled for one-tap customer approval. openData Studio makes these balance, passbook, sub-wallet and UPI collect records callable open data for exactly those builds.
Screenshots
API surface
The endpoints and request/response examples below are reconstructed from the app's interface — illustrative, not a live capture.
Fetch wallet & savings balance
POST
/v1/wallet/balanceopenbankingReads the user's Paytm Wallet and Paytm Payments Bank savings-account balance, including per-sub-wallet breakdown and the min/max transaction limits used to render the balance screen.
Auth: SSO session cookie plus user / channel token request headers; client channel and app version query params.
- accountBalance.value
- accountBalance.currency
- subWalletDetails
- partnerBankBalances
- redeemableInvestmentBalance
- payerAccountExists
- minTransactionAmount
- maxTransactionAmount
POST /v1/wallet/balance?channel=androidapp HTTP/1.1 Cookie: sso_session=<session-token> X-User-Token: <user-token> Content-Type: application/json {"subWalletParams":{"subWalletType":"all"}}{ "accountBalance": { "value": "1250.00", "currency": "INR" }, "subWalletDetails": [ { "subWalletType": 1, "subWalletName": "Paytm Wallet" } ], "partnerBankBalances": [], "redeemableInvestmentBalance": 0.0, "payerAccountExists": "true", "isRedemptionAllowed": false, "minTransactionAmount": { "value": "1.00", "currency": "INR" }, "maxTransactionAmount": { "value": "200000.00", "currency": "INR" } }Wallet passbook transaction history
POST
/v1/wallet/statementopenbankingReturns the paginated wallet/bank passbook (statement) with per-transaction id, status, amount, narration, counterparty, and fee detail that power the passbook and spend-analytics screens.
Auth: SSO session cookie plus user token request header; client channel query param.
- txnId
- txnStatus
- txnamount
- currencyCode
- payModeName
- txnCategory
- narration
- txnFrom
- txnTo
- payeeId
- payerId
- qrId
- walletOrderId
- txnPostDate
- feeDetails
- extendedTxnInfo
POST /v1/wallet/statement?channel=androidapp HTTP/1.1 Cookie: sso_session=<session-token> X-User-Token: <user-token> Content-Type: application/json {"pageNo":1,"pageSize":20,"entrytype":"all","subWalletType":"all"}{ "transactions": [ { "txnId": "1789965001234567", "txnStatus": "SUCCESS", "txnamount": "499.00", "currencyCode": "INR", "payModeName": "Paytm Wallet", "txnCategory": "P2P", "narration": "Paid to Merchant", "txnTo": "Merchant Store", "txnPostDate": "2026-09-20 21:30:00", "walletOrderId": "WO_9988776655" } ] }List sub-wallets
POST
/v1/wallet/sub-accountsopenbankingEnumerates the user's sub-wallets (main wallet, food wallet, gift vouchers) with issuer, account number, issue/expiry dates, and wallet type — used to build the wallet landing and passbook sub-wallet list.
Auth: SSO session cookie plus user token request header; client channel query param.
- id
- subWalletType
- subWalletName
- displayName
- accountNumber
- issuedOn
- expiry
- walletType
- issuerMetadata
POST /v1/wallet/sub-accounts?channel=androidapp HTTP/1.1 Cookie: sso_session=<session-token> X-User-Token: <user-token> Content-Type: application/json {}{ "subWallets": [ { "id": 1, "subWalletType": 1, "subWalletName": "Paytm Wallet", "displayName": "Paytm Balance", "accountNumber": "91XXXXXXXXXX", "issuedOn": "01-01-2021", "expiry": "31-12-2030", "walletType": "PAYTM", "issuerMetadata": "{}" } ] }Initiate UPI payment (collect)
POST
/v1/upi/collectopenbankingStarts a UPI collect against the app's payment backend, returning a transaction id and pending status that the app polls until the bank authorises it.
Auth: SSO session plus device binding; the collect is authorised in-app with the UPI PIN via the bank's MPC flow.
- txnId
- status
- payeeVpa
- payeeName
- amount
- currency
- txnNote
- approvalFlow
POST /v1/upi/collect HTTP/1.1 Cookie: sso_session=<session-token> Content-Type: application/json {"payeeVpa":"merchant@upi","payeeName":"Merchant Store","amount":"499.00","txnNote":"Order payment","channel":"androidapp"}{ "txnId": "UPI1789965001", "status": "PENDING", "payeeVpa": "merchant@upi", "amount": "499.00", "currency": "INR", "approvalFlow": "MPC_PIN" }
Data categories
- balances
- transactions
- wallets
- payments
- upi
Where teams use this data
Personal-finance aggregation
Money managers pull wallet and savings balances plus the passbook transaction history into one net-worth view, categorized by pay mode and narration.
Merchant reconciliation
Sellers reconcile settlements line by line — transaction id, amount, fee details, counterparty — matching wallet credits against their own order ledger.
UPI collection automation
ERP workflows initiate UPI collect requests straight from an overdue-invoice list, with payee name, amount and note pre-filled for one-tap customer approval.
Frequently asked questions
What data API does the Paytm app use?
The Paytm Android app calls a private HTTPS API split across payments, identity, UPI and bank-wallet backends. Endpoints such as POST /v1/wallet/balance and POST /v1/wallet/statement return balances, transaction history and sub-wallet details as JSON.
How is the Paytm API authenticated?
Requests carry an SSO session cookie along with user and channel token headers, and are tagged with a client channel and an app version. There is no public developer key — these are first-party endpoints used by the official app after a user logs in.
Can I read my Paytm wallet balance programmatically?
The app's own balance screen is powered by POST /v1/wallet/balance, which returns accountBalance.value and accountBalance.currency plus a subWalletDetails breakdown. It is a private, session-authenticated endpoint, not a public API.
Where does the Paytm passbook get its transactions?
The passbook and spend-analytics screens are fed by POST /v1/wallet/statement, a paginated endpoint returning txnId, txnStatus, txnamount, currencyCode, narration, counterparty and feeDetails for each wallet or bank transaction.
Apps similar to Paytm
- PhonePe — Walmart-backed UPI payments and wallet app that leads India's UPI transaction volumes in NPCI data.
- Google Pay — Google's UPI-based payments app for India, the second-largest UPI app by transaction volume.
- BHIM — The official UPI app from NPCI, the state-backed operator of India's UPI payment network.
- Amazon Pay — Wallet and UPI payments built into Amazon's India shopping ecosystem.
- BharatPe — Merchant-focused UPI app built around QR-code acceptance and lending for small businesses.
- Cred — Credit-card bill payment app with rewards that has expanded into UPI payments.
Topics
- Paytm API
- Paytm data API
- Paytm wallet API
- Paytm passbook API
- Paytm wallet balance endpoint
- Paytm Payments Bank API
- Paytm UPI endpoint
Need this app's data API integrated?
We deliver scoped integrations for any named app — from USD 500 with source-code handoff, or hosted access billed per call. Tell us the data you need.
- NDA + SOW on every engagement
- Delivery in 3–7 days
- Payment only after acceptance
- Work scoped to authorized use