Balance Inquiry API

Tips

Balance Inquiry

Brief Description

• Query the merchant's available, frozen, and unsettled balances.

Request URL

• /v1/paypro/queryBalance

Request Method

• POST

Header

header	Required	Type	Description
merchantNo	Yes	String	Merchant number

Request Body Parameters

Parameter	Required	Type	Description
timestamp	Yes	Long	Request timestamp in milliseconds
sign	Yes	String	Sort all fields except sign alphabetically and concatenate them as key1=value1key2=value2.... Use the app secret as the salt for MD5 encryption. The result must be lowercase.

Request Example

{
  "timestamp": 1719830171485,
  "sign": "ac13b9abf95c66ffc4025abaaeeb3a83"
}

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	Long	Transaction time
success	Yes	Boolean	Whether the API request was accepted
data	Yes	Object	Return object
data.availableAmount	Yes	Decimal	Available merchant balance in COP
data.freezeAmount	Yes	Decimal	Frozen merchant balance in COP
data.unsettledAmount	Yes	Decimal	Unsettled balance in COP; funds are moved to the available balance according to the T+1 settlement cycle

Successful Response Example

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