最新更新时间:2022.04.11 版本说明
商户发起添加分账接收方请求后,可通过调用本API来查询分账接收方添加结果。只有当微信审核接收方材料通过,接收方关系状态扭转为EFFECTIVE后,才允许调用请求分账API接口来分给该接收方。
适用对象:直连模式 机构模式
请求URL:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/receivers/{account}
请求方式:get
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
二级商户号 | sub_mchid | string[1, 32] | 否 | query微信支付分配的商户号,请与微信支付订单的二级商户号保持一致。(直连商户不需要,服务商/机构模式下必填) 示例值:1900000109 |
公众账号ID | appid | string[1, 32] | 否 | query与机构商户绑定的公众账号ID(AppID),平台会校验该字段与机构商之间是否存在有效绑定关系。分账接收方类型包含PERSONAL_OPENID时必填。 示例值:wx8888888888888888 |
二级商户公众账号ID | sub_appid | string[1, 32] | 否 | query机构服务商为二级商户配置绑定的公众账号ID,平台会校验机构服务商、二级商户和SubAppID之间的有效绑定关系。分账接收方类型包含PERSONAL_SUB_OPENID时必填。 示例值:wx8888888888888889 |
接收方类型 | type | string | 是 | query接收方类型 MERCHANT_ID:商户号 PERSONAL_OPENID:个人OpenID,由商户APPID转换得到 PERSONAL_SUB_OPENID:是个人Sub_OpenID,由二级商户APPID转换得到 示例值:MERCHANT_ID |
接收方账号 | account | string[1, 64] | 是 | path类型是MERCHANT_ID时,请填入商户号 类型是“PERSONAL_OPENID”时,请填入AppID对应的OpenID 类型是“PERSONAL_SUB_OPENID”时,请填入SubAppID对应的OpenID 示例值:86693852 |
https://api.mch.weixin.qq.com/v3/global/profit-sharing/receivers/86693852?sub_mchid=1900000109&appid=wx8888888888888888&sub_appid=wx8888888888888889&type=MERCHANT_ID
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
二级商户号 | sub_mchid | string[1, 32] | 否 | 二级商户号,同请求入参。 示例值:1900000109 |
接收方类型 | type | string | 是 | 接收方类型,同请求入参。 MERCHANT_ID:商户号 PERSONAL_OPENID:个人OpenID,由商户APPID转换得到 PERSONAL_SUB_OPENID:是个人Sub_OpenID,由二级商户APPID转换得到 示例值:MERCHANT_ID |
接收方账号 | account | string[1, 64] | 是 | 接收方账号,同请求入参。 示例值:86693852 |
分账接收方全称 | name | string[1, 1024] | 否 | 分账接收方全称,同请求入参。 示例值:hu89ohu89ohu89o |
与分账方的关系类型 | relation_type | string | 是 | 与分账方的关系类型,同请求入参。 SUPPLIER:供应商 DISTRIBUTOR:分销商 TAX_SERVICE_PROVIDER:税费服务商 IT_SERVICE_PROVIDER:技术服务提供方 CUSTOM:自定义 示例值:SUPPLIER |
自定义的分账关系 | custom_relation | string[1, 10] | 否 | 自定义的分账关系,同请求入参。 示例值:代理商 |
分账场景详细描述 | scene | string[3, 256] | 是 | 分账场景详细描述,同请求入参。 示例值:该分账接收方是境内税费服务提供方,帮助商户向境内海关代扣代缴税费。 |
接收方商户的主营业务范围 | major_service | string[3, 256] | 否 | 接收方商户的主营业务范围,同请求入参。 示例值:税务准备服务 |
分账接收方预计分账比例 | expected_ratio | int | 是 | 分账接收方预计分账比例,同请求入参。 示例值:2000 |
微信文件标识ID | file_id | string[10, 128] | 否 | 微信文件标识ID,同请求入参。 示例值:17b59418-b63c-4ac1-953a-d102dd2c80de |
接收方关系状态 | state | string | 是 | 分账方与该接收方的关系状态,仅允许对EFFECTIVE的接收方发起分账。 INIT:待审核,等待微信审核接收方资料 EFFECTIVE:生效中,接收方关系生效中 AUDIT_FAILED:审核未通过,接收方审核未通过 示例值:AUDIT_FAILED |
接收关系添加失败原因 | fail_reason | string | 否 | 添加分账接收方失败的原因,只有在state为AUDIT_FAILED时才会出现 PARTNERSHIP_NOT_SUPPORTED:合作关系不支持,分账接收方合作关系不支持分账 DEFAULT_ERROR: 默认错误, 示例值:PARTNERSHIP_NOT_SUPPORTED |
增加分账接收方申请函文件ID | application_file_id | string[10, 128] | 否 | 增加分账接收方申请函对应的文件ID 示例值:439d2325-f878-8960-8719-604ed42f1139 |
分账方与接收方合作关系证明文件ID | partnership_file_id | string[10, 128] | 否 | 分账方与接收方合作关系证明文件ID 示例值:de851a06-5a38-9d31-a102-275a17c477de |
{
"account": "86693852",
"application_file_id": "439d2325-f878-8960-8719-604ed42f1139",
"custom_relation": "代理商",
"expected_ratio": 2000,
"fail_reason": "PARTNERSHIP_NOT_SUPPORTED",
"file_id": "17b59418-b63c-4ac1-953a-d102dd2c80de",
"major_service": "税务准备服务",
"name": "hu89ohu89ohu89o",
"partnership_file_id": "de851a06-5a38-9d31-a102-275a17c477de",
"relation_type": "SUPPLIER",
"scene": "该分账接收方是境内税费服务提供方,帮助商户向境内海关代扣代缴税费。",
"state": "AUDIT_FAILED",
"sub_mchid": "1900000109",
"type": "MERCHANT_ID"
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
404 | NOT_FOUND | 分账关系不存在 | 请检查所传账户、接受方类型等字段是否填写正确 |
403 | NO_AUTH | 商户未签约境外分账产品能力 | 请参考产品流程和接入准备,确认商户具有分账权限后再发起请求 |
403 | NO_AUTH | 商户已开通分账产品能力,等待生效中(一般为第二天才生效) | 开通分账产品能力当天不能发起分账,请等待第二天后发起请求 |
403 | NO_AUTH | 商户父子关系不存在,请使用正确的二级商户号发起请求 | 请检查二级商户号(sub_mchid)是否填写正确 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP证