查询分账接收方添加结果
更新时间:2024.12.30商户发起添加分账接收方请求后,可通过调用本API来查询分账接收方添加结果。只有当微信审核接收方材料通过,接收方关系状态扭转为EFFECTIVE后,才允许调用请求分账API接口来分给该接收方。
1. 接口说明
适用对象:直连模式 机构模式
请求URL:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/receivers/{account}
请求方式:GET
Path 指该参数为路径参数
Query 指该参数为URL参数
Body 指该参数需在请求JSON传参
2. 请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
二级商户号 | sub_mchid | string[1, 32] | 否 | Query 微信支付分配的商户号,请与微信支付订单的二级商户号保持一致。(直连商户不需要,服务商/机构模式下必填) |
公众账号ID | appid | string[1, 32] | 否 | Query 微信分配的商户公众账号ID,分账接收方类型包含PERSONAL_OPENID时必填。 |
二级商户公众账号ID | sub_appid | string[1, 32] | 否 | Query 微信分配的二级商户公众账号ID,分账接收方类型包含PERSONAL_SUB_OPENID时必填。 |
接收方类型 | type | string | 是 | Query 接收方类型 |
接收方账号 | account | string[1, 64] | 是 | Path 类型是MERCHANT_ID时,是商户号 |
请求示例
URL
3. 返回参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
二级商户号 | sub_mchid | string[1, 32] | 否 | 二级商户号,同请求入参。 |
接收方类型 | type | string | 是 | 接收方类型,同请求入参。 |
接收方账号 | account | string[1, 64] | 是 | 接收方账号,同请求入参。 |
分账接收方全称 | name | string[1, 1024] | 否 | 分账接收方全称,同请求入参。 |
与分账方的关系类型 | relation_type | string | 是 | 与分账方的关系类型,同请求入参。 |
自定义的分账关系 | custom_relation | string[1, 10] | 否 | 自定义的分账关系,同请求入参。 |
分账场景详细描述 | scene | string[3, 256] | 是 | 分账场景详细描述,同请求入参。 |
接收方商户的主营业务范围 | major_service | string[3, 256] | 否 | 接收方商户的主营业务范围,同请求入参。 |
分账接收方预计分账比例 | expected_ratio | int | 是 | 分账接收方预计分账比例,同请求入参。 |
接收方关系状态 | state | string | 是 | 分账方与该接收方的关系状态,仅允许对EFFECTIVE的接收方发起分账。 |
接收关系添加失败原因 | fail_reason | string | 否 | 添加分账接收方失败的原因,只有在state为AUDIT_FAILED时才会出现 |
返回示例
正常示例
4. 错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
404 | NOT_FOUND | 分账关系不存在 | 请检查所传账户、接受方类型等字段是否填写正确 |
403 | NO_AUTH | 商户未签约境外分账产品能力 | 请参考产品流程和接入准备,确认商户具有分账权限后再发起请求 |
403 | NO_AUTH | 商户已开通分账产品能力,等待生效中(一般为第二天才生效) | 开通分账产品能力当天不能发起分账,请等待第二天后发起请求 |
403 | NO_AUTH | 商户父子关系不存在,请使用正确的二级商户号发起请求 | 请检查二级商户号(sub_mchid)是否填写正确 |