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
| Parameter | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | string | Merchant Number |
| sign | Yes | string | RSA Signature (Refer to Global Specification) |
Request Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| timestamp | Yes | Long | Millisecond 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
| Parameter | Type | Description |
|---|---|---|
| code | number | 1 for Success, 0 for Failure |
| msg | string | Message explanation |
| data | object | Returned data payload |
| └ merchantNo | string | Merchant Number |
| └ availableBalance | string | Available balance (can be used for payouts/withdrawals) |
| └ frozenBalance | string | Frozen/locked balance |
| └ unavailableBalance | string | Pending/uncleared balance (e.g., in-transit top-ups) |
