Skip to content

Get Wallet Balance ​

Query the balance and cumulative recharge/debit amounts of a wallet in a specified currency. If the account has no wallet record yet, a zero-balance object is returned and no wallet record is created. /papi/wallet/get is an alias path of the same interface.

Interface Address:

text
/papi/wallet/balance

Request Method:

text
POST

Content-Type:

text
application/json

Header Parameters:

ParameterTypeRequiredDescription
X-Access-KeystringYesAPI access key ID. See API Rules for authentication
X-SignaturestringYesSignature value, Base64-encoded HMAC-SHA256 result
X-TimestampstringYesMillisecond-level Unix timestamp (13 digits)
X-NoncestringYesRandom string, 10~32 lowercase letters + digits

Body Parameters:

ParameterTypeRequiredDescription
currencystringNoCurrency code, only USD is supported, defaults to USD

Request Example:

json
{
  "currency": "USD"
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataobjectResponse data
├─ currencystringCurrency code
├─ currencySymbolstringCurrency symbol, e.g. $ for USD
├─ balancestringCurrent wallet balance (cents)
├─ totalRechargeAmountstringCumulative recharge amount (cents)
├─ totalDebitAmountstringCumulative debit amount (cents)
├─ statusstringWallet status (NORMAL)
├─ versionstringWallet version
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": {
    "currency": "USD",
    "currencySymbol": "$",
    "balance": "1250",
    "totalRechargeAmount": "2000",
    "totalDebitAmount": "750",
    "status": "NORMAL",
    "version": "3"
  },
  "msg": ""
}
Copyright © 2026 HongKong Quantity Best Technology Limited

QTPhone Help Center