Skip to main content
POST
/
Gateway
/
v
{version}
/
Account
/
query-balance
curl --request POST \
  --url https://gateway.dev.waypay.live/Gateway/v1/Account/query-balance \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx'

{
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "walletId": "660e8400-e29b-41d4-a716-446655440000",
  "currentBalance": 125000.50,
  "pendingBalance": 15000.00,
  "availableBalance": 110000.50,
  "currency": "PKR",
  "pendingTransactionCount": 5,
  "pendingByTransactionType": {
    "Deposit": 10000.00,
    "Withdrawal": 5000.00
  },
  "retrievedAt": "2025-12-13T10:30:00Z"
}

​
Overview

This endpoint allows you to query your merchant wallet balance, including current balance, pending balance, and available balance for withdrawals.

​
Path Parameters

​
version
string
required
API version (e.g., “1”)

​
Response

​
userId
uuid
Merchant user ID
​
walletId
uuid
Unique wallet identifier
​
currentBalance
number
Current total balance in the wallet
​
pendingBalance
number
Total amount in pending transactions
​
availableBalance
number
Balance available for withdrawal or settlements
​
currency
string
Wallet currency code (e.g., “PKR”, “USD”)
​
pendingTransactionCount
integer
Number of transactions currently pending
​
pendingByTransactionType
object
Breakdown of pending amounts by transaction type
​
retrievedAt
datetime
Timestamp when balance was retrieved
curl --request POST \
  --url https://gateway.dev.waypay.live/Gateway/v1/Account/query-balance \
  --header 'SWICH-API-Key: pk_test_xxxxxxxx'

{
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "walletId": "660e8400-e29b-41d4-a716-446655440000",
  "currentBalance": 125000.50,
  "pendingBalance": 15000.00,
  "availableBalance": 110000.50,
  "currency": "PKR",
  "pendingTransactionCount": 5,
  "pendingByTransactionType": {
    "Deposit": 10000.00,
    "Withdrawal": 5000.00
  },
  "retrievedAt": "2025-12-13T10:30:00Z"
}

​
Best Practices

  • Check your balance before initiating settlements or payouts
  • Monitor pendingBalance to understand funds in transit
  • Use availableBalance to determine withdrawal capacity
  • Implement regular balance checks in your integration for financial reconciliation