通过用户标识查询签约

更新时间：2024.11.18

前置条件

商户接入教育续费通并申请了签约模板，拿到了签约模版唯一标识（plan_id）

接口功能

商户通过用户标识+签约模版号来查询用户签约信息，返回用户在该签约模版下的签约（一个签约模版仅会存在一个有效签约）；若用户未与该签约模版签约，返回明确错误码

接口说明

支持商户：【普通服务商】

请求方式：【GET】/v3/edu-papay/user/{openid}/contracts

请求域名：【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

　　　　　【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点，指引点击查看

请求参数

Header HTTP头参数

Authorization 　必填　string

请参考签名认证生成认证信息

Accept 　必填　string

请设置为application/json

path 路径参数

openid 　必填 string(128)

【服务商APPID下的用户标识】用户在服务商appid下的唯一标识

query 查询参数

appid 　必填 string(32)

【服务商APPID】微信公众平台为商户的应用分配的ID，与服务商商户号存在绑定关系

sub_mchid 　选填 string(32)

【子商户号】微信支付分配的商户号，服务商商户号与子商户号存在父子关系，如果是直连商户模式接入，不用填写

sub_appid 　选填 string(32)

【子商户APPID】微信公众平台为商户的应用分配的ID，与子商户号存在绑定关系，如果是直连商户模式接入，不用填写

sub_openid 　选填 string(128)

【子商户APPID下的用户标识】用户在子商户appid下的唯一标识

plan_id 　必填 string(32)

【签约模版号】签约模版号，签约模版唯一标识

contract_status 　选填 string(32)

【签约状态】ADD-签约（默认）; DELETE-解约

offset 　选填 integer

【分页页码】该次请求资源的起始位置，从0开始计数。调用方选填，默认为0

limit 　选填 integer

【分页大小】该次请求可返回的最大资源条数。调用方选填，默认值为20

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/edu-papay/user/oUpF8uMuAJOM2pxb1Q/contracts?appid=wx8888888888888888&sub_mchid=1900000109&sub_appid=wx8888888888888888&sub_openid=sub_openid_example&plan_id=101164396123311331&contract_status=ADD&offset=789&limit=20 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

data 　选填 array[object]

【结果集】符合条件的签约信息

属性

total_count 　选填 integer

【总数量】资源总条数

offset 　选填 integer

【分页页码】该次请求资源的起始位置，从0开始计数。调用方选填，默认为0

limit 　选填 integer

【分页大小】该次请求可返回的最大资源条数。调用方选填，默认值为20

应答示例

200 OK

1{
2  "data" : [
3    {
4      "sp_mchid" : "1230000109",
5      "appid" : "wx8888888888888888",
6      "sub_mchid" : "1900000109",
7      "sub_appid" : "wx8888888888888888",
8      "openid" : "oUpF8uMuAJOM2pxb1Q",
9      "sub_openid" : "oUpF8uMuAJOM2pxb1Q",
10      "plan_id" : "101164396123311331",
11      "contract_information" : {
12        "contract_id" : "wx998877665544wx",
13        "contract_status" : "ADD",
14        "create_time" : "2020-03-26T10:43:39+08:00"
15      }
16    }
17  ],
18  "total_count" : 30,
19  "offset" : 1,
20  "limit" : 20
21}
22

错误码

公共错误码

状态码	错误码	描述	解决方案
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是否正确

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服