通过协议号查询签约

更新时间：2024.11.18

商户通过签约协议号可查询签约信息，当合约不存在时返回明确错误码。

接口说明

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

请求方式：【GET】/v3/eduschoolpay/contracts/{contract_id}

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

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

请求参数

Header HTTP头参数

Authorization 　必填　string

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

Accept 　必填　string

请设置为application/json

path 路径参数

contract_id 　必填 string(32)

【签约协议号】微信用户在校园轻松付下的合约的唯一标识，用户在校园轻松付小程序完成签约后，由微信支付生成。

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/eduschoolpay/contracts/2045011120563805041758214605 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

contract_id 　必填 string(32)

【签约协议号】微信用户在校园轻松付下的合约的唯一标识，用户在校园轻松付小程序完成签约后，由微信支付生成。

mchid 　必填 string(32)

【商户号】微信支付分配的商户号。
如果是服务商模式接入则为服务商商户号；如果是直连商户模式接入则为直连商户号。

appid 　必填 string(32)

【商户AppID】微信公众平台（mp.weixin.qq.com）为商户分配的公众账号ID，与商户号存在绑定关系。
如果是服务商模式接入则为服务商商户号绑定的AppID；如果是直连商户模式接入则为直连商户号绑定的AppID。

openid 　必填 string(128)

【商户AppID下的用户标识】用户在商户AppID下的唯一标识。如果是服务商模式接入则为服务商商户AppID下的唯一标识；如果是直连商户模式接入则为直连商户AppID下的唯一标识。

plan_id 　必填 string(32)

【签约模板号】签约模板的唯一标识。商户在商户平台（pay.weixin.qq.com）接入校园轻松付，并为学校申请了签约模板后，由微信支付生成。

contract_status 　必填 string(32)

【签约状态】ADD-已签约; DELETE-已解约

create_time 　必填 string(32)

【签约时间】签约完成时间，使用rfc3339所定义的格式，即为YYYY-MM-DDThh:mm:ss+TIMEZONE

out_contract_code 　必填 string(64)

【外部签约号】由商户自行生成的签约号，要求64个字符内，只能是数字、大小写字母和_-，且在同一签约模板下唯一。

应答示例

200 OK

1{
2  "contract_id" : "2045011120563805041758214605",
3  "mchid" : "1230000109",
4  "appid" : "wx8888888888888888",
5  "openid" : "oUpF8uMuAJOM2pxb1Q",
6  "plan_id" : "101164396123311331",
7  "contract_status" : "ADD",
8  "create_time" : "2017-08-26T09:43:39+08:00",
9  "out_contract_code" : "20190806125346"
10}
11

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误	请根据错误提示正确传入参数
400	INVALID_REQUEST	HTTP 请求不符合微信支付 APIv3 接口规则	请参阅接口规则
401	SIGN_ERROR	验证不通过	请参阅签名常见问题
500	SYSTEM_ERROR	系统异常，请稍后重试	请稍后重试

业务错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误，请检查contract_id	参数错误，请检查contract_id为合约回调通知中的值
404	NOT_FOUND	未找到对应合约	合约不存在，请确认contract_id正确且与当前商户匹配；如确认无误则可能是用户已删除合约。
429	RATELIMIT_EXCEEDED	达到调用速率限制	接口调用频率过快，请降低请求频率
500	SYSTEM_ERROR	出现内部服务器错误	5开头的错误码均为系统错误，请使用相同的参数稍后重试

文档是否有帮助

更多支持

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