最新更新时间:2022.06.14 版本说明
商户发起添加分账接收方请求,建立分账接收方列表。后续可通过发起分账请求,将分账方商户结算后的资金,分给该分账接收方。
1. 一份分账接收关系涉及分账方和接收方:
其中分账方是指【发起方商户】或【发起方商户和其二级商户】(直连商模式下为直连商户号;服务商模式或境外机构商模式下,为父商户号以及二级商户号);
接收方是指接收分账资金的个人微信账号或商户号,商户在添加接收方信息时需提供接收方类型及接收方账号;
以境外机构商模式举例,机构商商户A下有两个二级商户A1和A2已经接入分账服务,其中B1是A1商户的合作方,B2是A2商户的合作方;
——此时机构商A为了实现A1商户的分账订单分账给B1,则需要添加以下分账关系:mchid:A + sub_mchid: A1 + account: B1;
——为了实现A2商户的分账订单分账给B2,则需要添加:mchid:A + sub_mchid: A2 + account: B2;
2. 商户在发起添加分账接收方请求之前,需要先调用境外文件上传API来提交接收方商户的合作关系附件,以供微信进行分账接收关系的审核。请提前准备如下合作关系材料,若资料上传不齐全,可能审批不通过。
【合作关系材料说明】
a. 双方合作关系合同材料:
当分账接收方为境内企业,需提交跨境电商与分账接收方的合作合同的电子扫描件(必收);当分账接收方为境内个人,针对每个二级商户(跨境电商)只需要提供一次跨境电商与某个境内个人合作关系证明的样例。
b. 分账接收方申请函,详见模板增加分账接收方承诺函。
3. 调用本接口成功后,接收方关系状态为INIT。待微信审核接收方材料通过,接收方关系状态扭转为EFFECTIVE后,方可调用请求分账API接口来分给该接收方。可调用查询分账接收方添加结果API来确认分账接收方关系是否已经生效(审核完成)。
4. 若接收方关系审核失败,可根据审核失败原因字段提示,重新在文件上传API提交合规完整的审核材料后,重新发起添加接收方请求。注:INIT/EFFECTIVE状态下的分账接收方不允许再对该接收方发起添加请求。
适用对象:直连模式 机构模式
请求URL:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/receivers
请求方式:POST
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
二级商户号 | sub_mchid | string[1, 32] | 否 | body微信支付分配的商户号,请与微信支付订单的二级商户号保持一致。(直连商户不需要,服务商/机构模式下必填) 示例值:1900000109 |
公众账号ID | appid | string[1, 32] | 否 | body与机构商户绑定的公众账号ID(AppID),平台会校验该字段与机构商之间是否存在有效绑定关系。分账接收方类型包含`PERSONAL_OPENID`时必填。 示例值:wx8888888888888888 |
二级商户公众账号ID | sub_appid | string[1, 32] | 否 | body机构服务商为二级商户配置绑定的公众账号ID,平台会校验机构服务商、二级商户和SubAppID之间的有效绑定关系。分账接收方类型包含“PERSONAL_SUB_OPENID”时必填。 示例值:wx8888888888888889 |
接收方类型 | type | string | 是 | body接收方类型。 MERCHANT_ID:商户号, PERSONAL_OPENID:AppID对应的OpenID PERSONAL_SUB_OPENID:SubAppID对应的OpenID 示例值:MERCHANT_ID |
接收方账号 | account | string[1, 64] | 是 | body类型是MERCHANT_ID时,请填入商户号 类型是“PERSONAL_OPENID”时,请填入AppID对应的OpenID 类型是“PERSONAL_SUB_OPENID”时,请填入SubAppID对应的OpenID 示例值:86693852 |
分账接收方全称 | name | string[1, 1024] | 否 | body设置说明: 1. 注:此字段需要加密,加密方法详见文档开头的:敏感信息加密说明 2. 按照不同接收方类型,请按照如下说明进行设置: a. 分账接收方类型是MERCHANT_ID时,是商户全称(必传); b. 分账接收方类型是PERSONAL_OPENID或PERSONAL_SUB_OPENID时,是个人姓名(选传,若传入则会校验该字段值与微信支付侧的实名信息是否一致,且需要设置authorized字段来确认是否获取用户信息授权) 示例值:Merchant name |
是否已经获取用户实名信息授权 | authorized | boolean | 否 | body商户向微信支付传输用户姓名及账户信息,微信支付后台将协助校验用户信息一致性,降低分账接收方填写错误的风险。该字段为商户确认传输的用户信息的授权状态: 1)false代表未获取用户授权,微信支付将拒绝接收数据 2)true代表已获取用户授权,微信支付将正常接收数据 注意,当接收方类型为用户(PERSONAL_OPNEID/PERSONAL_SUB_OPENID)且选择传入账户名称(即name字段)时,该字段为必填项 示例值:true |
与分账方的关系类型 | relation_type | string | 是 | body分账商户与接收方的关系。 SUPPLIER:供应商 DISTRIBUTOR:分销商 TAX_SERVICE_PROVIDER:税费服务商 IT_SERVICE_PROVIDER:技术服务提供方 CUSTOM:自定义 示例值:SERVICE_PROVIDER |
自定义的分账关系 | custom_relation | string[1, 10] | 否 | body分账方与接收方具体的关系,本字段最多10个字。 当字段relation_type的值为CUSTOM时,本字段必填 当字段relation_type的值不为CUSTOM时,本字段无需填写 示例值:代理商 |
分账场景详细描述 | scene | string[3, 256] | 是 | body请商户对于分账场景进行具体描述。 示例值:该分账接收方是境内税费服务提供方,帮助商户向境内海关代扣代缴税费。 |
接收方商户的主营业务范围 | major_service | string[3, 256] | 否 | body描述该公司主体的主营业务范围。当接收方类型为MERCHANT_ID时,本字段必填。 示例值:税务准备服务 |
分账接收方预计分账比例 | expected_ratio | int | 是 | body指所添加的分账接收方预计可能达到的最高分账比例,此处仅作信息收集,不代表实际最高分账比例,实际允许的最高分账比例以平台策略为准。 单位万分比,比如2000表示20%。 示例值:2000 |
增加分账接收方申请函文件ID | application_file_id | string[10, 128] | 否 | body请参考API开头的【材料提交方式说明】。增加分账接收方申请函对应的文件ID,请使用文件上传API进行提交,获取到文件标识ID之后,再填入该字段。 示例值:439d2325-f878-8960-8719-604ed42f1139 |
分账方与接收方合作关系证明文件ID | partnership_file_id | string[10, 128] | 否 | body请参考API开头的【材料提交方式说明】。分账方与接收方合作关系证明对应的文件ID,若接收方类型为MERCHANT_ID,则该字段必填(若采用V1.0版本合并资料提交的方式则不做要求);请使用文件上传API进行提交,获取到文件标识ID之后,再填入该字段。 示例值:de851a06-5a38-9d31-a102-275a17c477de |
{
"account": "1900000109",
"expected_ratio": 1000,
"partnership_file_id":"83f5c0f9-7c0d-4b3b-9136-ef16fd9cb644",
"application_file_id":"3a00187-426c-4815-8ea7-b0d1ef46647b",
"major_service": "税务准备服务",
"name": "tdcUez3ov/jAzO2sDwLap6uc8d2itP6ffhoQzOa9LDzrMOqz/+reA79+e3aijKn0dQ2tPA391byJY6VqSaPhCpDJgvoawBYCNxkPR+ID9SYq/axfI4hN66aO/d8PWcKyEV/4AuVJEJ3ZIhvJXfnkoxmP6vF3yv7g1zS/IL1dTHCqY4X2tTpko4BRylcfz2Fi82CLbSegaB1h3SOsmstiC/wf2MM5rSnamgTAKA0a7w5+0QsvmNWbU9pVkOnHCGTGLUQFpDMpDvMtJS/f8vrrCPAeJa6ijwF7WLOqTV3cVWFYAtSC3iSDGyD7p2axHqsrirJo8fq63lYSRrTia1vgnA==",
"relation_type": "TAX_SERVICE_PROVIDER",
"scene": "该分账接收方是境内税费服务提供方,帮助商户向境内海关代扣代缴税费。",
"sub_mchid": "999968480",
"type": "MERCHANT_ID"
}
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
二级商户号 | sub_mchid | string[1, 32] | 否 | 二级商户号,同请求入参。 示例值:1900000109 |
接收方类型 | type | string | 是 | 接收方类型,同请求入参。 MERCHANT_ID:商户号 PERSONAL_OPENID: AppID对应的OpenID PERSONAL_SUB_OPENID:SubAppID对应的OpenID 示例值: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 |
接收方关系状态 | 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":"of8YZ6LPmjDmYAqdobIvwTdQQjR8",
"custom_relation":"特约主播",
"expected_ratio":800,
"relation_type":"CUSTOM",
"scene":"该分账接收方为特约带货主播",
"state":"EFFECTIVE",
"sub_mchid": "999968480",
"type":"PERSONAL_OPENID",
"partnership_file_id":"83f5c0f9-7c0d-4b3b-9136-ef16fd9cb644",
"application_file_id":"3a00187-426c-4815-8ea7-b0d1ef46647b"
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 用户类型为PERSONAL_OPENID,参数appid未设置 | 用户类型为PERSONAL_OPENID,请设置appid字段 |
400 | INVALID_REQUEST | 用户类型为PERSONAL_SUB_OPENID,参数sub_appid未设置 | 用户类型为PERSONAL_SUB_OPENID,请设置sub_appid字段 |
400 | INVALID_REQUEST | 若接收方类型为MERCHANT_ID,请在name字段设置接收方商户全称 | 若接收方类型为MERCHANT_ID,请在name字段设置接收方商户全称 |
400 | INVALID_REQUEST | 若接收方类型为MERCHANT_ID,请在major_service字段设置接收方商户的主营业务范围 | 请检查分账接收方列表,去除同一次分账请求中的重复账户后再执行请求 |
400 | INVALID_REQUEST | 若接收方关系类型为CUSTOM时,请设置custom_relation字段 | 若接收方关系类型为CUSTOM时,请设置custom_relation字段 |
400 | INVALID_REQUEST | 个人接收方选择传入姓名字段但未确认用户授权状态 | 若选择传入个人接收方姓名以执行用户实名信息一致性校验,需要商户先获取用户授权,并设置authorized字段为true |
400 | INVALID_REQUEST | 个人接收方在微信侧的实名信息与传入的姓名字段值不一致 | 请和接收方用户确认实名信息无误后,再执行请求 |
400 | INVALID_REQUEST | 已经存在一条分账接收方方关系记录,且预期最大分出比例(expected_ratio)与本次请求不符 | 请检查账户及预期最大分出比例是否填写正确,若已经添加过该接收方,可通过【查询分账接收方添加结果API】查询结果 |
400 | INVALID_REQUEST | 已经存在一条分账接收方方关系记录,且上传的审核文件ID字段(file_id)与本次请求不符 | 请检查账户及审核文件ID字段(file_id)是否填写正确,若已经添加过该接收方,可通过【查询分账接收方添加结果API】查询结果 |
400 | INVALID_REQUEST | 传入的AppID与发起商户的绑定关系不存在 | 请确认appid字段和发起方商户是否绑定成功 |
400 | INVALID_REQUEST | 传入的SubAppID与对应二级商户的绑定关系不存在 | 请确认sub_appid字段和二级商户是否绑定成功,机构商可在商户平台>Institution>Application>对应二级商户的Development configuration上查看该二级商户绑定的sub_appid |
400 | INVALID_REQUEST | 请商户参照平台指引提交分账合作关系资料 | 请商户参照平台指引提交分账合作关系资料 |
400 | INVALID_REQUEST | 请商户参照平台指引提交分账合作关系资料中的“分账接收方申请函” | 请商户参照平台指引提交分账合作关系资料中的“分账接收方申请函” |
400 | INVALID_REQUEST | 接收方用户未实名认证 | 添加用户接收方时对应的用户未实名认证,请引导用户先进行实名认证,否则其微信零钱账户无法接受入金请求 |
400 | INVALID_REQUEST | 已经存在一条分账接收方方关系记录,且上传的双方合作关系合同文件ID字段(partnership_file_id)与本次请求不符 | 请检查账户及双方合作关系合同文件ID字段(partnership_file_id)是否填写正确,若已经添加过该接收方,可通过【查询分账接收方添加结果API】查询结果 |
400 | INVALID_REQUEST | 已经存在一条分账接收方方关系记录,且上传的分账接收方申请函文件ID字段(application_file_id)与本次请求不符 | 请检查账户及分账接收方申请函文件ID字段(application_file_id)是否填写正确,若已经添加过该接收方,可通过【查询分账接收方添加结果API】查询结果 |
403 | NO_AUTH | 商户未签约境外分账产品能力 | 请参考产品流程和接入准备,确认商户具有分账权限后再发起请求 |
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证