Query Fund Settlement Details
Update Time:2025.01.07The merchant can query the details of both settled funds (sette_state is SETTLED) and unsettled funds (sette_state is UNSETTLE) by settlement date.
|
1. API intro
Applicable object: Common mode Institutional mode
Request Url:https://apihk.mch.weixin.qq.com/v3/global/settle/settlements
Request method:GET
Path parameter is a path parameter.
Query parameter needs to be passed in the request URL.
Body parameter needs to be passed in the request JSON.
2. Request Parameters
Name | Variable Name | Type | Required | Description |
---|---|---|---|---|
Sub-merchant ID | sub_mchid | string[1,32] | No | Query The merchant ID assigned by WeChat Pay for the sub-merchant |
Settlement Status | settle_state | string[1,32] | Yes | Query Fund settlement status. |
Settlement Start Date | settle_start_date | string[1,8] | No | Query
Example: 20091225 |
Settlement End Date | settle_end_date | string[1,8] | No | Query
Example: 20091226 |
Maximum Count | limit | int | Yes | Query |
Start Position of Record | offset | int | Yes | Query The start position of the requested resources. |
Request Example
URL
3. Response Parameters
Name | Variable Name | Type | Required | Description |
---|---|---|---|---|
Settlement Information List | data | array | No | Details of the settlement information |
Total Count | total_count | int | Yes | Total number of resources. If offset is 0 or no record is found for this query, this parameter is returned. |
Start Position of Record | offset | int | Yes | The start position of the resources for this query |
Records Returned | limit | int | Yes | The number of records found for this query is returned. |
Return Example
SUCCESS
ERROR
4. Error Code
Error Message | Description | Solution |
---|---|---|
SYSTEM_ERROR | System error | System error. Try again later. |
PARAM_ERROR | Parameter error | Parameter error. Check it and try again. |
FREQUENCY_LIMITED | Too many attempts | Too many attempts. Try again later. |
RESOURCE_NOT_EXISTS | Record not found | Record not found. Modify the parameter and try again. |