CashBook staff UPI wallet and passbook data API
CashBook - Balance & Expense is a business cashbook and staff-wallet app for India from Obopay, listed on Google Play as Obopay – Payment Wallet for Businesses. Owners keep shared books — a regional petty-cash book, say — as cash-in / cash-out registers with running totals, and each entry is categorised, filed under its book and opened on a detail screen with its attached receipts. Alongside the books, every staff member gets a prepaid UPI wallet with its own UPI ID, activated by a phone-number OTP sign-in with SMS auto-read, device binding and UPI PIN setup. Field staff pay vendors by Scan & Pay or a typed UPI ID, pick saved vendors from a party list instead of re-typing bank details, request money through UPI collect and raise top-up requests when their float runs low; owners approve or reject those requests from an approval queue, disburse float from the company wallet and switch between businesses, wallet payments can be copied into any book, and each wallet shows its per-day and per-transaction spend limits on a limits screen. A business registers with its GSTIN and completes business KYC before wallets go live, and staff wallets carry a minimum-KYC or full-KYC level. The app is built for Indian SMEs with field teams — site engineers drawing UPI float, for example — where prepaid staff wallets replace petty-cash boxes and reimbursement chits and every spend settles over UPI instead of cash. It sits between digital ledger apps like Khatabook, OkCredit and Vyapar, UPI merchant apps like BharatPe for Business and Paytm, and desktop accounting in TallyPrime, combining the bookkeeping of the first group with the payment rails of the second.
Petty-cash books and staff UPI wallets leave two matching trails of the same money. The passbook side pages cash-in / cash-out rows — txnId, txnAmount, entryType, paymentMode, payeeName, upiId, remarks, categoryId and the bookId / bookName each row was filed under — with running cashIn and cashOut totals, and every row opens into a full receipt that adds approvalStatus, the linked partyId and partyName, and virtualAccountDetails carrying accountNumber, ifsc and bankName. The issuer side is the prepaid UPI ledger itself: pay and collect history keyed by utr and rrn with a collectRequest flag, so each UPI debit can be matched back to the passbook row it landed in.
Balances arrive in three layers: the staff wallet snapshot keyed by its digitalAccount (walletBalance, closingBalance, dailyLimit, perTransactionLimit, staffWallet), the company wallet that funds it (businessId, businessName, mcc), and the issuer-side PPI balance flagged with custbalanceStatus and kycStatus. The bound UPI profile adds each wallet's vpa and its minKyc / fullKyc level; GSTIN verification returns the business's legal businessName, tradeName and mcc; the party list holds every vendor's and staff member's upiId, gstin, accountNumber, ifsc and beneficiaryName; and recharge requests are tracked by rechargeRequestId, memberId, amount and approvalStatus from PENDING through to the disbursement that funds the wallet.
Finance teams run nightly jobs that read staff wallet balances, page the passbook and match utr, rrn and txnId onto Tally or Zoho Books lines, so petty-cash books close without screenshots passed around on WhatsApp. Corporate onboarding flows submit a gstin and watch minKyc, fullKyc and the company wallet balance, issuing staff wallets only once GSTIN and MCC are on file. Ops dashboards surface top-ups still PENDING and push the same rechargeRequestId, memberId and amount into disbursement, so site engineers receive UPI float without handling cash. Compliance mirrors the device-bound UPI history together with each wallet's vpa, dailyLimit and kycStatus to evidence staff spend against the passbook. openData Studio turns these wallets, passbooks and approval queues into callable open data.
Screenshots
API surface
The endpoints and request/response examples below are reconstructed from the app's interface — illustrative, not a live capture.
Send staff-wallet OTP
POST
/v1/wallet/auth/otp/startopenfinanceStarts the staff-wallet login used before any balance, passbook or UPI call. The SMS OTP it sends is consumed by the OTP-verify call to open a session.
Auth: Unauthenticated bootstrap. The phone number identifies the staff or owner wallet; signed-in calls later attach an Authorization Bearer identity token.
- phoneNumber
- deviceId
- sessionId
- status
- phoneAuthRequestId
POST /v1/wallet/auth/otp/start HTTP/1.1 Content-Type: application/json { "phoneNumber": "9876543210", "deviceId": "a1b2c3d4e5f6" }{ "status": "SENT", "sessionId": "otp-sess-9f2a", "phoneNumber": "9876543210", "phoneAuthRequestId": "par-44120" }Verify OTP and open wallet session
POST
/v1/wallet/auth/otp/verifyopenfinanceConsumes the SMS OTP and returns the session tokens, KYC flags and digitalAccount id that gate staff-wallet balances and UPI pay/collect.
Auth: Unauthenticated. The body carries phoneNumber plus the SMS otp; the returned accessToken and refreshToken are sent as Authorization Bearer on later wallet calls.
- accessToken
- refreshToken
- idToken
- kycStatus
- minKyc
- fullKyc
- walletStatus
- digitalAccount
- role
POST /v1/wallet/auth/otp/verify HTTP/1.1 Content-Type: application/json { "phoneNumber": "9876543210", "otp": "482913", "deviceId": "a1b2c3d4e5f6" }{ "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example", "refreshToken": "rt_7c11ab", "idToken": "id-token-example", "kycStatus": "MIN_KYC", "minKyc": true, "fullKyc": false, "walletStatus": "ACTIVE", "digitalAccount": "CBW-998877", "role": "STAFF" }Read staff UPI wallet balance
GET
/v1/wallets/staff/balanceopenbankingReturns the signed-in staff (or owner) prepaid wallet snapshot rendered on the wallet home: live balance, closing balance and per-day / per-transaction spend limits.
Auth: Authorization Bearer accessToken from the OTP-verify call.
- digitalAccount
- walletBalance
- accountBalance
- closingBalance
- currency
- walletStatus
- dailyLimit
- perTransactionLimit
- limitAmount
- staffWallet
GET /v1/wallets/staff/balance HTTP/1.1 Authorization: Bearer <accessToken>{ "digitalAccount": "CBW-998877", "walletBalance": "12500.00", "accountBalance": "12500.00", "closingBalance": "11840.50", "currency": "INR", "walletStatus": "ACTIVE", "dailyLimit": "50000.00", "perTransactionLimit": "10000.00", "limitAmount": "50000.00", "staffWallet": true }Read business wallet balance
GET
/v1/business/account/balanceopenbankingReads the company-level digital account that funds staff wallets and bulk disbursements, including the merchant category code used for spend controls.
Auth: Authorization Bearer accessToken from the OTP-verify call; scoped to the active businessId.
- businessId
- businessName
- walletBalance
- accountBalance
- currency
- walletStatus
- mcc
GET /v1/business/account/balance?businessId=biz-10482 HTTP/1.1 Authorization: Bearer <accessToken>{ "businessId": "biz-10482", "businessName": "Noida Packers", "walletBalance": "842300.00", "accountBalance": "842300.00", "currency": "INR", "walletStatus": "ACTIVE", "mcc": "4214", "checkPaymentsEnabled": true }List staff-wallet passbook transactions
GET
/v1/wallet/ledger/entriesopenbankingPages the staff-wallet passbook that backs the cash-in / cash-out register, including UPI UTR/RRN, payee VPA, category and the book each row was copied into.
Auth: Authorization Bearer accessToken from the OTP-verify call.
- txnId
- transactionId
- txnAmount
- amount
- currency
- txnStatus
- entryType
- paymentMode
- payeeName
- upiId
- utr
- rrn
- remarks
- categoryId
- bookId
- bookName
- cashIn
- cashOut
GET /v1/wallet/ledger/entries?page=1&pageSize=20 HTTP/1.1 Authorization: Bearer <accessToken>{ "items": [ { "txnId": "TXN-1789965001", "transactionId": "OBP-889900", "txnAmount": "499.00", "amount": "499.00", "currency": "INR", "txnStatus": "SUCCESS", "entryType": "CASH_OUT", "paymentMode": "UPI", "payeeName": "Metro Cash & Carry", "upiId": "metro@okicici", "utr": "609912345678", "rrn": "609912345678", "remarks": "Packaging material", "categoryId": "cat-ops", "bookId": "book-22", "bookName": "Petty cash — North" } ], "summary": { "cashIn": "15000.00", "cashOut": "499.00" } }Fetch a single wallet transaction
GET
/v1/wallet/ledger/entryopenbankingReturns the full receipt for one passbook row — UPI identifiers, approval state, linked party and any virtual-account payout details shown on the entry screen.
Auth: Authorization Bearer accessToken from the OTP-verify call.
- txnId
- transactionId
- txnAmount
- txnStatus
- paymentMode
- payeeName
- upiId
- utr
- rrn
- remarks
- approvalStatus
- categoryId
- partyId
- partyName
- virtualAccountDetails
- accountNumber
- ifsc
- bankName
GET /v1/wallet/ledger/entry?txnId=TXN-1789965001 HTTP/1.1 Authorization: Bearer <accessToken>{ "txnId": "TXN-1789965001", "transactionId": "OBP-889900", "txnAmount": "499.00", "txnStatus": "SUCCESS", "paymentMode": "UPI", "payeeName": "Metro Cash & Carry", "upiId": "metro@okicici", "utr": "609912345678", "rrn": "609912345678", "remarks": "Packaging material", "approvalStatus": "AUTO_APPROVED", "categoryId": "cat-ops", "partyId": "pty-441", "partyName": "Metro Cash & Carry", "virtualAccountDetails": { "accountNumber": "502000112233", "ifsc": "HDFC0000123", "bankName": "HDFC Bank" } }Read UPI PPI account balance
POST
/v1/ppi/accounts/balanceopenbankingReads the issuer-side prepaid (PPI) ledger that the app shows as the staff UPI wallet, distinct from the cashbook paper balance, including KYC and account-status flags.
Auth: Bearer from the PPI token call after device binding; used alongside the wallet session for the prepaid account.
- accountBalance
- walletBalance
- currency
- walletStatus
- custbalanceStatus
- kycStatus
- digitalAccount
POST /v1/ppi/accounts/balance HTTP/1.1 Authorization: Bearer <ppi-token> Content-Type: application/json { "digitalAccount": "CBW-998877", "deviceId": "a1b2c3d4e5f6" }{ "accountBalance": "12500.00", "walletBalance": "12500.00", "currency": "INR", "walletStatus": "ACTIVE", "custbalanceStatus": "ACTIVE", "kycStatus": "MIN_KYC" }UPI transaction history
POST
/v1/ppi/upi/transactionsopenbankingReturns issuer-side UPI history for the bound device (pay and collect), including UTR/RRN used to match rows back into the passbook.
Auth: Bearer from the PPI token call after device binding.
- txnId
- txnAmount
- txnStatus
- upiId
- payeeName
- utr
- rrn
- remarks
- collectRequest
POST /v1/ppi/upi/transactions HTTP/1.1 Authorization: Bearer <ppi-token> Content-Type: application/json { "digitalAccount": "CBW-998877", "pageNo": 1, "pageSize": 20 }{ "txns": [ { "txnId": "UPI-609912345678", "txnAmount": "499.00", "txnStatus": "SUCCESS", "upiId": "metro@okicici", "payeeName": "Metro Cash & Carry", "utr": "609912345678", "rrn": "609912345678", "remarks": "Packaging material", "collectRequest": false } ] }Read bound UPI profile
POST
/v1/ppi/upi/profileopenfinanceReturns the VPA, KYC level and UPI spend limits for the device-bound staff wallet after PIN setup on the issuer's UPI bridge page.
Auth: Bearer from the PPI token call after device-token generation and binding verification.
- vpa
- upiId
- kycStatus
- minKyc
- fullKyc
- walletStatus
- digitalAccount
- perTransactionLimit
- dailyLimit
- deviceId
- deviceToken
POST /v1/ppi/upi/profile HTTP/1.1 Authorization: Bearer <ppi-token> Content-Type: application/json { "deviceId": "a1b2c3d4e5f6", "deviceToken": "dev-tok-88" }{ "vpa": "staff.neha@wallet", "upiId": "staff.neha@wallet", "kycStatus": "MIN_KYC", "minKyc": true, "fullKyc": false, "walletStatus": "ACTIVE", "digitalAccount": "CBW-998877", "perTransactionLimit": "10000.00", "dailyLimit": "50000.00" }Verify business GSTIN
POST
/v1/business/kyc/gstin/verifyopendataLooks up a GSTIN during corporate registration so the app can attach a legal name, trade name and merchant category before wallet activation and staff disbursements.
Auth: Authorization Bearer accessToken from the OTP-verify call.
- gstin
- businessName
- tradeName
- mcc
- kycStatus
POST /v1/business/kyc/gstin/verify HTTP/1.1 Authorization: Bearer <accessToken> Content-Type: application/json { "gstin": "07AABCU9603R1ZX", "businessId": "biz-10482" }{ "gstin": "07AABCU9603R1ZX", "businessName": "Noida Packers Private Limited", "tradeName": "Noida Packers", "mcc": "4214", "kycStatus": "MIN_KYC" }List business parties
GET
/v1/business/partiesopendataReturns vendors and staff already linked to the business — VPA, bank and GSTIN — so Scan & Pay and recharge requests can pick a counterparty without re-typing.
Auth: Authorization Bearer accessToken from the OTP-verify call.
- partyId
- partyName
- upiId
- phoneNumber
- gstin
- ifsc
- accountNumber
- bankName
- beneficiaryName
GET /v1/business/parties?businessId=biz-10482 HTTP/1.1 Authorization: Bearer <accessToken>{ "parties": [ { "partyId": "pty-441", "partyName": "Metro Cash & Carry", "upiId": "metro@okicici", "phoneNumber": "9810012345", "gstin": "07AABCU9603R1ZX", "ifsc": "HDFC0000123", "accountNumber": "502000112233", "bankName": "HDFC Bank", "beneficiaryName": "Metro Cash And Carry India" } ] }List staff recharge requests
GET
/v1/wallet/topupsopenfinanceLists pending and historical staff wallet top-ups that owners approve or reject; the same flow drives disbursement into the prepaid wallet.
Auth: Authorization Bearer accessToken from the OTP-verify call. Owner/admin role required to approve.
- rechargeRequestId
- memberId
- digitalAccount
- amount
- currency
- approvalStatus
- remarks
- bookId
- bookName
GET /v1/wallet/topups?businessId=biz-10482&status=PENDING HTTP/1.1 Authorization: Bearer <accessToken>{ "requests": [ { "rechargeRequestId": "RR-77881", "memberId": "usr-neha", "digitalAccount": "CBW-998877", "amount": "5000.00", "currency": "INR", "approvalStatus": "PENDING", "remarks": "Site visit — Gurugram", "bookId": "book-22", "bookName": "Petty cash — North" } ] }Process a UPI collect request
POST
/v1/ppi/upi/collectopenfinanceAccepts or pays a UPI collect against the staff wallet — the Scan & Pay / request-money path that posts into the passbook once the UTR confirms.
Auth: Bearer from the PPI token call; the UPI PIN is entered on the issuer's bridge page.
- upiId
- txnAmount
- remarks
- deviceId
- txnId
- txnStatus
- utr
- rrn
- collectRequest
- payeeName
POST /v1/ppi/upi/collect HTTP/1.1 Authorization: Bearer <ppi-token> Content-Type: application/json { "upiId": "vendor@okhdfcbank", "txnAmount": "2500.00", "remarks": "Invoice 8821", "deviceId": "a1b2c3d4e5f6", "collectRequest": true }{ "txnId": "UPI-609998877665", "txnStatus": "SUCCESS", "txnAmount": "2500.00", "utr": "609998877665", "rrn": "609998877665", "collectRequest": true, "payeeName": "Noida Packers" }Issue UPI PPI API token
POST
/v1/ppi/auth/tokenopenfinanceMints the prepaid-account token used by the UPI profile, history, balance and pay/collect calls after the staff wallet OTP session exists.
Auth: Called after OTP wallet login. The body carries deviceId; the returned Bearer is required for the UPI and account-management calls.
- accessToken
- tokenType
- digitalAccount
- deviceId
POST /v1/ppi/auth/token HTTP/1.1 Content-Type: application/json Authorization: Bearer <accessToken> { "deviceId": "a1b2c3d4e5f6", "digitalAccount": "CBW-998877" }{ "accessToken": "ppi-tok-88", "tokenType": "Bearer", "digitalAccount": "CBW-998877", "deviceId": "a1b2c3d4e5f6" }Read staff-wallet spend limits
GET
/v1/wallet/limitsopenbankingReturns the per-day and per-transaction prepaid caps shown on the staff-wallet limits screen, separate from the live balance snapshot.
Auth: Authorization Bearer accessToken from the OTP-verify call.
- digitalAccount
- dailyLimit
- perTransactionLimit
- limitAmount
- currency
- walletStatus
GET /v1/wallet/limits HTTP/1.1 Authorization: Bearer <accessToken>{ "digitalAccount": "CBW-998877", "dailyLimit": "50000.00", "perTransactionLimit": "10000.00", "limitAmount": "50000.00", "currency": "INR", "walletStatus": "ACTIVE" }Initiate staff-wallet UPI pay
POST
/v1/ppi/upi/payopenfinanceDebits the staff prepaid wallet toward a VPA (Scan & Pay or a typed UPI ID), returning UTR/RRN that later land in the passbook.
Auth: Bearer from the PPI token call after device binding; the UPI PIN is entered on the issuer's bridge page.
- upiId
- txnAmount
- remarks
- deviceId
- digitalAccount
- txnId
- txnStatus
- payeeName
- utr
- rrn
POST /v1/ppi/upi/pay HTTP/1.1 Authorization: Bearer <ppi-token> Content-Type: application/json { "upiId": "metro@okicici", "txnAmount": "499.00", "remarks": "Packaging material", "deviceId": "a1b2c3d4e5f6", "digitalAccount": "CBW-998877" }{ "txnId": "UPI-609912345678", "txnStatus": "SUCCESS", "txnAmount": "499.00", "upiId": "metro@okicici", "payeeName": "Metro Cash & Carry", "utr": "609912345678", "rrn": "609912345678" }Disburse funds into a staff wallet
POST
/v1/wallet/topups/disburseopenfinanceMoves company-wallet float into a staff prepaid wallet after a recharge request is approved — the owner-side counterpart of the top-up request list.
Auth: Authorization Bearer accessToken from the OTP-verify call. Owner/admin role required.
- businessId
- memberId
- digitalAccount
- amount
- currency
- rechargeRequestId
- remarks
- txnStatus
- approvalStatus
POST /v1/wallet/topups/disburse HTTP/1.1 Authorization: Bearer <accessToken> Content-Type: application/json { "businessId": "biz-10482", "memberId": "usr-neha", "digitalAccount": "CBW-998877", "amount": "5000.00", "currency": "INR", "rechargeRequestId": "RR-77881", "remarks": "Site visit — Gurugram" }{ "rechargeRequestId": "RR-77881", "txnStatus": "SUCCESS", "amount": "5000.00", "currency": "INR", "digitalAccount": "CBW-998877", "approvalStatus": "APPROVED", "memberId": "usr-neha" }
Data categories
- balances
- transactions
- upi
- kyc
- parties
- wallets
- recharge-requests
Where teams use this data
Reconcile staff UPI spend into the cashbook
Nightly jobs read the staff wallet balance and page through passbook entries, then match utr, rrn and txnId onto Tally or Zoho Books lines so petty-cash books close without screenshot WhatsApps.
Onboard a GSTIN-verified business wallet
Corporate KYC submits the business gstin for verification, then watches minKyc, fullKyc and the company wallet balance so finance issues staff wallets only after GSTIN and MCC are on file.
Approve field-staff recharge requests
Ops dashboards list top-up requests still PENDING approval (rechargeRequestId, memberId, amount) and push the same ids into disbursement so site engineers receive UPI float without handling cash.
Mirror NPCI UPI history for audit
Compliance pulls the device-bound UPI history and the wallet profile (vpa, dailyLimit, kycStatus) from the prepaid-account endpoints to evidence staff spend against the passbook.
Frequently asked questions
Which CashBook endpoints return wallet balances?
GET /v1/wallets/staff/balance returns the staff prepaid wallet (walletBalance, closingBalance, dailyLimit, perTransactionLimit). GET /v1/business/account/balance is the company digital account that funds those wallets. POST /v1/ppi/accounts/balance reads the issuer-side ledger for the same prepaid account, including kycStatus and custbalanceStatus.
How does CashBook authenticate payment calls?
The client first posts phoneNumber to POST /v1/wallet/auth/otp/start and confirms the SMS code at POST /v1/wallet/auth/otp/verify. The returned accessToken is sent as Authorization Bearer on wallet and business calls. UPI pay and collect additionally use a device-bound prepaid token from POST /v1/ppi/auth/token.
Can I get UPI transaction history, not just cashbook entries?
Yes. POST /v1/ppi/upi/transactions returns issuer-side rows (txnId, utr, rrn, upiId, collectRequest) for the bound device. GET /v1/wallet/ledger/entries is the passbook view of the same spend, adding bookName, categoryId and cash-in/cash-out totals.
Where does GSTIN verification happen?
During corporate registration the app posts gstin to POST /v1/business/kyc/gstin/verify and stores businessName, tradeName, mcc and kycStatus before wallet activation, so staff disbursements only start once the business identity is on file.
Apps similar to CashBook - Balance & Expense
- Khatabook — Khatabook is an Indian digital-bookkeeping app that lets small businesses record customer credit (udhaar), billing and collections on a phone instead of a paper register.
- OkCredit — OkCredit is a free digital ledger app for Indian businesses that replaces paper credit registers with phone-based udhaar tracking and payment reminders.
- Vyapar Invoice GST Billing App — Vyapar is an Indian SME app for GST invoicing, accounting and inventory, named alongside OkCredit as a Khatabook rival in digital bookkeeping.
- BharatPe for Business — BharatPe for Business is a merchant payments app that gives Indian shops a UPI QR code for accepting customer payments and tracking collections.
- Paytm — Paytm is a major Indian UPI payments app that competes with PhonePe, Google Pay and BharatPe across consumer and merchant payments.
- TallyPrime — TallyPrime is the long-established accounting software Indian small businesses use to maintain cash books, ledgers and GST records.
Topics
- CashBook API
- staff UPI wallet
- Obopay PPI
- passbook transactions
- GSTIN verification
- recharge requests
- Indian SME cashbook
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