Weixin Pay Open Platform

Return Home / Cross-border Funds-Distribution / Deleting Receiver API

Deleting Receiver API

Latest update time：2022.05.18 Release notes

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

API Intro

Request Url:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/receivers

Request method:DELETE

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.

Request Parameters

Name	Variable Name	Type	Required	Description
Sub-merchant ID	sub_mchid	string[1, 32]	No	query 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	query 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	query 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	query 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	query 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

Request Sample

Example：

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

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

Return Parameters

The request is processed successfully without any response content.

Return Example


204
The request is processed successfully without any response content.

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

Error Code

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
400	INVALID_REQUEST	If the receiver type is MERCHANT_ID, set the merchant full name of the receiver in the name field	If the receiver type is MERCHANT_ID, set the merchant full name of the receiver in the name field
400	INVALID_REQUEST	If the receiver type is MERCHANT_ID, set the major service scope of receiver in the major_service field	Check receiver list and remove duplicate IDs in the same request before requesting funds-distribution
400	INVALID_REQUEST	When the receiver relationship type is CUSTOM, set the custom_relation field	When the receiver relationship type is CUSTOM, set the custom_relation field
400	INVALID_REQUEST	Personal receiver selects to upload the name field but does not confirm authorized status of user	If the personal receiver selects to upload the name to verify the consistency with user's real-name information, the merchant needs to obtain the user authorization first and set the authorized field to true
400	INVALID_REQUEST	The real name information of the personal receiver on the WeChat side does not match the uploaded name field value	Confirm with the receiver their real-name information before executing the request
400	INVALID_REQUEST	A receiver relationship record has already existed and the expected maximum split ratio (expected_ratio) is not consistent with the request	Check whether the account and expected maximum distribution proportion are correctly filled in. If the receiver has been added, query the result through [Adding Receiver Result Query API]
400	INVALID_REQUEST	A receiver relationship record has already existed and the uploaded file id field (file_id) to be audited is not consistent with the request	Check whether the account and the file ID field (file_id) are filled in correctly. If the receiver has been added, query the result through [Adding Receiver Result Query API]
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

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

Cross-border Funds-Distribution API

Deleting Receiver API

API Intro

Request Parameters

Request Sample

Example：

Return Parameters

Return Example

Error Code

Release notes