Query Merchant Balance (/payout/balance)
Description
Merchants invoke this endpoint to query their real-time account balances on the platform (available balance, frozen balance, unavailable/in-transit funds).
Request Information
- Endpoint:
/payout/balance - Method:
POST - Content-Type:
application/json; charset=utf-8
HTTP Headers
| Header | Required | Type | Description |
|---|---|---|---|
merchantNo | Yes | String | Merchant ID |
sign | Yes | String | Base64-encoded RSA digital signature of request body |
Request Body Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
timestamp | Yes | Long | 1772880600000 | Epoch timestamp in milliseconds |
Request Payload Example
json
{
"timestamp": 1772880600000
}Response Parameters
Success Response
json
{
"code": 1,
"msg": "ok",
"data": {
"merchantNo": "M1652264659533",
"availableBalance": "971.40",
"frozenBalance": "0.00",
"unavailableBalance": "100.00"
}
}Failure Response
json
{
"code": 0,
"msg": "invalid merchant"
}Response Fields Description
| Field | Type | Description |
|---|---|---|
code | Integer / String | Status code: 1 success, 0 failure |
msg | String | Message description |
data | Object | Account balance details |
data.merchantNo | String | Merchant ID |
data.availableBalance | String | Available Balance (Funds readily available for payouts or withdrawals) |
data.frozenBalance | String | Frozen Balance (Funds withheld due to security, disputes, or reserves) |
data.unavailableBalance | String | Unavailable / In-transit Balance (Funds pending settlement or in clearing) |
