Balance Inquiry API

Tips

Balance Inquiry

Brief Description

• None (No specific description provided)

Request URL

• /v1/payproPK/queryBalance

Request Method

• POST

Header

Header Field	Required	Type	Description
merchantNo	Yes	string	(No description)

Request Body Parameters

Parameter Name	Required	Type	Description
timestamp	Yes	string	Timestamp
sign	Yes	string	Encryption signature

Example Request Body:

{
  "timestamp": "1724151084278",
  "sign": "774ac9334c7c36d8fa92ffbaf2129c6d"
}

Successful Response

Parameter Name	Required	Type	Description
msg	Yes	string	Request result (indicating success but not for logical judgment)
code	Yes	string	Request response code (indicating success but not for logical judgment)
timestamp	Yes	string	Example timestamp value (e.g., 1715941383720)
success	Yes	string	Transaction result (boolean outcome)
data	Yes	Object	Returned data object
data.availableAmount	Yes	string	Merchant balance
data.freezeAmount	Yes	string	Frozen amount
data.unsettledAmount	Yes	string	Amount pending settlement

Example Successful Response:

{
    "msg": "success",
    "code": "0000",
    "timestamp": "1719830171485",  // Note: The type should be string in consistency with the description, even though it looks like a number
    "success": "true",            // Note: Typically, "true" should be without quotes in JSON, but here it's kept as a string for consistency with the provided example
    "data": {
        "availableAmount": "9998989.0000",
        "unsettledAmount": "0.0000",
        "freezeAmount": "0.0000"
    }
}