Skip to content

Merchant Balance Query

Merchants query their available, frozen, and pending balances on the platform via this interface.


Interface Info

  • Endpoint: /payout/balance
  • HTTP Method: POST
  • Content-Type: application/json; charset=utf-8

Request Header Parameters

ParameterRequiredTypeDescription
merchantNoYesstringMerchant Number
signYesstringRSA Signature (Refer to Global Specification)

Request Body Parameters

ParameterRequiredTypeDescription
timestampYesLongMillisecond timestamp

Response Examples

json
{
  "code": 1,
  "msg": "ok",
  "data": {
    "merchantNo": "M1652264659533",
    "availableBalance": "971.40",
    "frozenBalance": "0.00",
    "unavailableBalance": "100.00"
  }
}
json
{
  "code": 0,
  "msg": "param merchant error"
}

Response Parameter Description

ParameterTypeDescription
codenumber1 for Success, 0 for Failure
msgstringMessage explanation
dataobjectReturned data payload
merchantNostringMerchant Number
availableBalancestringAvailable balance (can be used for payouts/withdrawals)
frozenBalancestringFrozen/locked balance
unavailableBalancestringPending/uncleared balance (e.g., in-transit top-ups)