Balance Inquiry API

Tips

Balance Inquiry

API Documentation for Querying Merchant Balance

Brief Description

None

Request URL

/v1/paypro/queryBalance

Request Method

POST

Header	Required	Type	Description
merchantNo	Yes	string	-

Request Body Parameters

Name	Required	Type	Description
timestamp	Yes	string	Timestamp
sign	Yes	string	Encrypted value

Request Example

{
  "timestamp": "1724151084278"
}

Successful Response

Parameter Name	Required	Type	Description
msg	Yes	string	Request result (Returning "success" only indicates the request was successful; it should not be used for merchant-side logic)
code	Yes	string	Request response code (Returning "0000" only indicates the request was successful; it should not be used for merchant-side logic)
timestamp	Yes	string	Timestamp (e.g., 1715941383720)
success	Yes	string	Transaction result
data	Yes	Object	Response object
data.availableAmount	Yes	string	Merchant's available balance
data.freezeAmount	Yes	string	Frozen amount
data.unsettledAmount	Yes	string	Unsettled amount

Successful Response Example

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