Balance Inquiry API

Tips

Balance Inquiry

Brief Description

• None

Request URL

• /api/balance

Request Method

• POST

Header

header	Required	Type	Description
merchantNo	Yes	string	None

Successful Response

Parameter	Required	Type	Description
msg	Yes	string	Request result (when returning success, it only indicates that the request was successful and cannot be used for merchant-side logic judgment)
code	Yes	string	Request response code (when returning 0000, it only indicates that the request was successful and cannot be used for merchant-side logic judgment). For specific error codes, please refer to the business error code enumeration.
timestamp	Yes	string	Transaction time
success	Yes	string	Transaction result
data	Yes	Object	Return object
data.availablAmount	Yes	string	Merchant balance
data.freezeAmount	Yes	string	Frozen amount
data.unsettledAmount	Yes	string	Unsettled amount, all receipts for the day will be automatically settled to the available balance on T+1

Successful Response Example

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1719830171485,
    "success": true,
    "data": {
        "availablAmount": 9998989.0000,
        "unsettledAmount": 0.0000,
        "freezeAmount": 0.0000
    }
}