查询最大分账比例API
更新时间:2024.11.13应用场景
服务商可以查询子商户设置的允许服务商分账的最大比例。
接口频率:30QPS
接口说明
请求Url | https://api.mch.weixin.qq.com/pay/profitsharingmerchantratioquery |
---|---|
是否需要证书 | 否 |
请求方式 | post |
签名方式 | HMAC-SHA256 |
请求参数
名称 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mch_id | 是 | string(32) | 1900000100 | 微信支付分配的服务商户号 |
子商户号 | sub_mch_id | 二选一传入 | string(32) | 1900000109 | 微信支付分配的子商户号,即分账的出资商户号。普通分账传入子商户号时,查询子商户号的设置的最大分账比例。 |
品牌主商户号 | brand_mch_id | string(32) | 1900000108 | 当服务商开通了“连锁品牌工具”后,使用品牌供应链分账时,传入品牌主商户号,查询品牌主设置的全局分账比例,品牌主下的门店适用于此比例。 | |
随机字符串 | nonce_str | 是 | string(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,不长于32位。推荐随机数生成算法 |
签名 | sign | 是 | string(64) | C380BEC2BFD727A4B6845133519F3AD6C380BEC2BFD727A4B6845133519F3AD6 | 签名,详见签名生成算法 |
签名类型 | sign_type | 否 | string(32) | HMAC-SHA256 | 签名类型,目前只支持HMAC-SHA256 |
举例如下:
返回结果
名称 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态码 | return_code | 是 | string(32) | SUCCESS | 枚举值: SUCCESS:分账回退处理成功 FAIL:分账回退处理失败 |
错误代码 | err_code | 否 | string(32) | SYSTEMERROR | 如果返回状态码为FAIL,则本字段存在,且为失败的错误码 详见错误码列表 |
返回信息 | err_msg | 否 | string(256) | 参数格式校验错误 | 如果返回状态码为FAIL,则本字段存在,且为失败的错误信息 |
以下字段在return_code为SUCCESS的时候有返回
名称 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mch_id | 是 | string(32) | 1900000100 | 调用接口时提供的服务商户号。 |
子商户号 | sub_mch_id | 否 | string(32) | 1900000109 | 微信支付分配的子商户号,即分账的出资商户号。查询子商户号的设置的最大分账比例(普通分账)时返回此字段。 |
品牌主商户号 | brand_mch_id | 否 | string(32) | 1900000108 | 调用接口时提供的品牌主商户号。查询品牌主商户设置的全局分账比例(品牌分账)时返回此字段。 |
最大分账比例 | max_ratio | 是 | int | 2000 | 子商户允许服务商分账的最大比例,单位万分比,比如2000表示20% |
随机字符串 | nonce_str | 是 | string(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 微信返回的随机字符串 |
签名 | sign | 是 | string(64) | C380BEC2BFD727A4B6845133519F3AD6 | 微信返回的签名,详见签名算法 |
举例:
错误码列表
名称 | 描述 | 原因 | 解决方案 |
---|---|---|---|
SYSTEMERROR | 接口返回错误 | 系统超时 | 请使用相同参数再次调用API。 |
PARAM_ERROR | 参数错误 | 请求参数未按指引进行填写 | 请求参数错误,请检查参数再调用分账申请 |
NO_AUTH | 权限异常 | 服务商未开通分账功能 | 请先开通分账功能 |
服务商未与子商户签约 | 请先签约子商户 | ||
子商户未开通分账功能 | 请先开通子商户的分账功能 |