API Dictionary / Funds Distribution / Deleting Receiver API

Deleting Receiver API

Latest update time：2022.08.04 Release notes

Merchant initiates a request to delete receiver. The settled funds of the merchant cannot be distributed to the deleted receiver.

1. API Intro

Applicable object： Common mode Institutional mode

API rules：https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/receivers

Request method：Delete

Pathparameter is a path parameter.

Queryparameter needs to be passed in the request URL.

Bodyparameter 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 WeChat Pay. It needs to be consistent with the sub-merchant ID in the transaction of WeChat Pay. Note: Only forInstitutional mode Example: 1900000109
Official account ID	appid	string[1, 32]	No	Body?Merchant official account ID allocated by WeChat. When the receiver type includes PERSONAL_OPENID, its filling is required. Example: wx8888888888888888
Sub-merchant official account ID	sub_appid	string[1, 32]	No	Body?Sub-merchant official account ID allocated by WeChat. When the receiver type includes PERSONAL_SUB_OPENID, its filling is required. Note: Only forInstitutional mode Example: wx8888888888888889
Receiver type	type	string	Yes	Body?Receiver type. MERCHANT_ID: Merchant ID, PERSONAL_OPENID: Personal OpenID, converted by merchant APPID PERSONAL_SUB_OPENID: Personal Sub_OpenID, converted by sub-merchant APPID Example: MERCHANT_ID
Receiver account	account	string[1, 64]	Yes	Body?When the type is MERCHANT_ID, it is a merchant ID When the type is PERSONAL_OPENID, it is a personal OpenID When the type is PERSONAL_SUB_OPENID, it is a personal Sub_OpenID Example: 86693852

Delete receiver of merchant Delete receiver of user


{
    "account": "1900000109",
    "sub_mchid": "999968480",
    "type": "MERCHANT_ID"
  }


{
    "account": "of8YZ6LPmjDmYAqdobIvwTdQQjR8",
    "appid": "wx78898sdfwe9888835", 
    "type": "PERSONAL_OPENID", 
    "sub_mchid": "999968480"
}


									{
										"stock_id": ".NET",
										"limit": 10,
									}


									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

The request is processed successfully without any response content.

SUCCESSERROR


204
The request is processed successfully without any response content.


{
	"code": "SYSTEM_ERROR",
	"message": "Parameter?error"
}


									{
										"stock_id": ".NET",
										"limit": 10,
									}


									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

Error Codes	Error Message	Description	Solution
400	INVALID_REQUEST	The user type is PERSONAL_SUB_OPENID, the sub_appid in parameter is not set	The user type is PERSONAL_OPENID, please set appid field
400	INVALID_REQUEST	The user type is PERSONAL_SUB_OPENID, the sub_appid in parameter is not set	The user type is PERSONAL_SUB_OPENID, please set sub_appid field
403	NO_AUTH	The merchant has not signed the overseas funds-distribution product	Refer to the product process and access preparation, confirm that the merchant has funds-distribution authorization, and initiate the request again
403	NO_AUTH	The merchant has enabled the funds-distribution product and is waiting for it to take effect (Usually takes effect the next day)	The funds-distribution function cannot be initiated on the first day. Please initiate the request on the next day
403	NO_AUTH	Receiver	Confirm that the receiver is legally compliant before requesting funds-distribution
403	NO_AUTH	The parent-child relationship of the merchant does not exist. Please use correct sub-merchant ID to initiate the request	Please check if the sub-merchant ID (sub_mchid) is filled in correctly

Page Navigation