Latest update time:2022.05.18 Release notes
For transactions that do not require funds-distribution, call the API directly to unfreeze all the transaction amount to the sponsor account (original transaction funds settlement account); After the funds-distribution interface is called, and when remaining funds need to be unfrozen, call the API to unfreeze all remaining funds to the sponsor.
● The API is in asynchronous processing mode, that is, after receiving the merchant's request, it will be accepted first and then processed asynchronously, and the final funds-distribution result can be obtained through the Funds-distribution Result Query API;
● After the return of this API is successful, the amount of unfrozen funds outbound, together with the non-funds-distribution transaction amount, is subject to the net settlement. The regulations are consistent with the settlement period, starting point and other withdrawal rules in the settlement contract with the merchant;
● The sponsor refers to the merchant who has actually settled the funds and entered the funds into the account via Weixin Pay. It refers to a merchant in the overseas institution mode, and a sub-merchant in the service provider mode.
Request Url:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/orders/unfreeze
Request method:POST
API rules: https://wechatpay-api.gitbook.io/wechatpay-api-v3
Applicable object:Common modeInstitutional mode
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.
Name | Variable Name | Type | Required | Description |
---|---|---|---|---|
Sub-merchant ID | sub_mchid | string[1, 32] | No | body Sub-merchant ID allocated by Weixin Pay. It needs to be consistent with the sub-merchant ID in the transaction of Weixin Pay. Note: Only forInstitutional mode Example:1900000109 |
Weixin Pay transaction ID | transaction_id | string[1, 32] | Yes | body Weixin Pay transaction ID Example:4208450740201411110007820472 |
Merchant order No. | out_order_no | string[1, 64] | Yes | body The order No. in the merchant system, which is unique. It can only include numbers, capital letters and lowercase letters _-. Note: This order No. is used to identify different requests of funds-distribution commands (including funds-distribution request API/unfreezing remaining funds API) initiated from the merchant side. If the funds of one transaction is distributed multiple times, change the [merchant order No.] before requesting funds-distribution. Otherwise it will be considered as a repeated request. Example:P20150806125346 |
Funds-distribution description | description | string[1, 80] | Yes | body Reason description of funds-distribution, to be reflected in the funds-distribution record Example:Unfreeze all remaining funds |
{
"description": "Unfreeze all remaining funds",
"out_order_no": "P20150806125346",
"sub_mchid": "1900000109",
"transaction_id": "4208450740201411110007820472"
}
Name | Variable Name | Type | Required | Description |
---|---|---|---|---|
Sub-merchant ID | sub_mchid | string[1, 32] | No | Merchant ID allocated by Weixin Pay Note: Only forInstitutional mode Example:1900000109 |
Weixin Pay order No. | transaction_id | string[1, 32] | Yes | Weixin Pay transaction ID Example:4208450740201411110007820472 |
Merchant order No. | out_order_no | string[1, 64] | Yes | Merchant order No., same as the request parameter. Example:P20150806125346 |
Weixin order ID | order_id | string[1, 64] | Yes | Weixin order ID, the unique identifier returned by Weixin system. Example:3008450740201411110007820472 |
Funds-distribution order state | state | string | Yes | Funds-distribution order state (see result field in receivers for funds-distribution results of each receiver). PROCESSING: Funds-distribution is processing, FINISHED: Funds-distribution is finished, Example:FINISHED |
+ Receiver list | receivers | array[1,50] | Yes | Receiver list When a merchant initiates a funds-distribution request or a unfreeze the remaining funds request, the same transaction funds can be distributed to multiple receivers (including unfreezing funds to the sponsor). The funds-distribution detail describes each funds-distribution state of each receiver. |
{
"order_id": "7100000751202203238029563456088",
"out_order_no": "P20150806125346",
"receivers": [
{
"account": "999952224", # sponsor merchant ID
"amount": 995,
"create_time": "2022-03-23T17:59:23+08:00",
"currency": "CNY",
"description": "Unfreeze all remaining funds",
"detail_id": "7200000751202203238029563456171",
"detail_type": "UNFREEZE_TO_SPONSOR",
"rate_value": 83640300,
"result": "PENDING",
"settlement_amount": 1189,
"settlement_currency": "HKD",
"type": "MERCHANT_ID"
}
],
"state": "PROCESSING",
"sub_mchid": "1900000109",
"transaction_id": "4208450740201411110007820472"
}
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP证