Balance Inquiry API

Tips

Balance Inquiry

Request URL

• /v1/payproVN/queryBalance

Request Method

• POST

Header

Parameter	Required	Type	Description
merchantNo	Yes	string	Merchant number

Request Body Parameters

Name	Required	Type	Description
timestamp	Yes	string	Timestamp of the request.
sign	Yes	string	Encrypted signature.

Request Example

{
  "timestamp": "1724151084278",
  "sign": "8d1bdd4d9d6b642c6843464c72e6a5a1"
}

Successful Response

Parameter	Required	Type	Description
msg	Yes	string	Request result (only indicates the success of the current request, not for merchant-side logic).
code	Yes	string	Response code (only indicates the success of the current request, not for merchant-side logic). For specific error codes, refer to the business error code enumeration.
timestamp	Yes	string	Timestamp of the response.
success	Yes	string	Transaction result.
data	Yes	Object	Returned object.
data.availableAmount	Yes	string	Merchant balance.
data.freezeAmount	Yes	string	Frozen amount.
data.unsettledAmount	Yes	string	Amount pending settlement.

Successful Response Example

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