通过用户标识查询签约
更新时间:2023.07.21前置条件
商户接入教育续费通并申请了签约模板,拿到了签约模版唯一标识(plan_id
)
接口功能
商户通过用户标识+签约模版号来查询用户签约信息,返回用户在该签约模版下的签约(一个签约模版仅会存在一个有效签约);若用户未与该签约模版签约,返回明确错误码
# 接口说明
支持商户:
【普通服务商】
请求方式:
【GET】/v3/edu-papay/user/{openid}/contracts
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看
# 请求参数
- Authorization 必填请参考 签名认证 生成认证信息
- Accept 必填请设置为
application/json
Header HTTP头参数
- openid 必填【服务商APPID下的用户标识】 用户在服务商appid下的唯一标识
Path 路径参数
- appid 必填【服务商APPID】 微信公众平台为商户的应用分配的ID,与服务商商户号存在绑定关系
- sub_mchid 选填【子商户号】 微信支付分配的商户号,服务商商户号与子商户号存在父子关系,如果是直连商户模式接入,不用填写
- sub_appid 选填【子商户APPID】 微信公众平台为商户的应用分配的ID,与子商户号存在绑定关系,如果是直连商户模式接入,不用填写
- sub_openid 选填【子商户APPID下的用户标识】 用户在子商户appid下的唯一标识
- plan_id 必填【签约模版号】 签约模版号,签约模版唯一标识
- contract_status 选填【签约状态】 ADD-签约(默认); DELETE-解约
- offset 选填【分页页码】 该次请求资源的起始位置,从0开始计数。调用方选填,默认为0
- limit 选填【分页大小】 该次请求可返回的最大资源条数。调用方选填,默认值为20
Query 查询参数
请求示例
GET
# 应答参数
- data 选填【结果集】 符合条件的签约信息
- 属性
- total_count 选填【总数量】 资源总条数
- offset 选填【分页页码】 该次请求资源的起始位置,从0开始计数。调用方选填,默认为0
- limit 选填【分页大小】 该次请求可返回的最大资源条数。调用方选填,默认值为20
200OK
应答示例
200 OK
# 错误码
# 公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
# 业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 系统错误 | 系统异常,请使用相同参数稍后重新调用 |
403 | NO_AUTH | 商户无权限 | 请开通商户号权限。请联系产品或商务申请 |
403 | NOT_ENOUGH | 余额不足 | 用户账号余额不足,请用户充值或更换支付卡后再支付 |
429 | RATELIMIT_EXCEEDED | 频率限制 | 请降低频率后重试 |
400 | INVALID_REQUEST | 请求的业务参数符合参数格式,但不符合业务规则 | 请使用正确的参数重新调用 |
401 | SIGN_ERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求 |
400 | ALREADY_EXISTS | 资源已存在 | 尝试创建的资源已存在,无需重复创建 |
404 | NOT_FOUND | 请求的资源不存在 | 请商户检查需要查询的ID或者请求URL是否正确 |
文档是否有帮助