Skip to content

Vexora API Documentation

Check Balance

Check Balance¶

Brief Description¶

Use this API to get partner balance.

Request URL¶

/v1/vexora/queryBalance

Request Method¶

Method: POST
Content-Type: application/json

Header	Required	Type	Description
merchantNo	Yes	String	Merchant number assigned by Vexora.

Request Body Parameters¶

Name	Required	Type	Desc
timestamp	Yes	String	Request timestamp in milliseconds, for example `1715941383720`.
sign	Yes	String	Request signature. Sort all non-empty request body parameters except `sign` by parameter name in ascending alphabetical order, concatenate them as `key1=value1key2=value2`, append the app secret, and generate a lowercase MD5 hash.

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

Response Parameters¶

Name	Required	Type	Desc
msg	Yes	String	Request message. A value such as `success` only indicates that the query request was accepted.
code	Yes	String	API request status code. `0000` means the query request was processed successfully by the API layer.
timestamp	Yes	Integer	Response timestamp in milliseconds.
success	Yes	Boolean	Whether the balance query request succeeded.
data	Yes	Object	Balance response object.
data.availableAmount	Yes	Float	Available merchant balance.
data.freezeAmount	Yes	Float	Frozen amount.
data.unsettledAmount	Yes	Float	Amount to be settled. Same-day collection funds are automatically settled into the available balance on T+1.

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