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¶
| Header | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | String | Merchant number assigned by Vexora. This value must be submitted in the request header. |
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. |
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 | String | Response timestamp in milliseconds. |
| success | Yes | Boolean | API request result. This field indicates whether the query request succeeded. |
| data | Yes | Object | Balance response object. |
| data.availableAmount | Yes | String | Available merchant balance. |
| data.freezeAmount | Yes | String | Frozen amount. |
| data.unsettledAmount | Yes | String | Amount to be settled. Same-day collection funds are automatically settled into the available balance on T+1. |