通过协议号查询签约

更新时间：2024.11.18

前置条件

完成签约后，商户系统接收并保存了微信后台系统回调的签约协议号（contract_id）

接口功能

商户通过签约协议号可查询签约信息。如果对应签约状态为“已签约”或“已解决”，会返回签约信息。如果签约信息不存在，返回明确错误码

接口说明

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

请求方式：【GET】/v3/edu-papay/contracts/id/{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)

【签约协议号】标识用户与某签约模版的一次签约，具有唯一性

query 查询参数

appid 　必填 string(32)

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

sub_mchid 　选填 string(32)

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

sub_appid 　选填 string(32)

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

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/edu-papay/contracts/id/wx998877665544wx?appid=wx8888888888888888&sub_mchid=1900000109&sub_appid=wx8888888888888888 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

sp_mchid 　必填 string(32)

【服务商商户号】微信支付分配的商户号

appid 　必填 string(32)

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

sub_mchid 　选填 string(32)

【子商户号】微信支付分配的商户号，服务商商户号与子商户号存在父子关系，如果是直连商户模式接入，该字段返回为空

sub_appid 　选填 string(32)

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

openid 　选填 string(128)

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

sub_openid 　选填 string(128)

【子商户APPID下的用户标识】用户在子商户appid下的唯一标识，如果是直连商户模式接入，该字段返回为空

plan_id 　选填 string(32)

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

contract_information 　选填 object

【签约信息】签约信息

属性

应答示例

200 OK

1{
2  "sp_mchid" : "1230000109",
3  "appid" : "wx8888888888888888",
4  "sub_mchid" : "1900000109",
5  "sub_appid" : "wx8888888888888888",
6  "openid" : "oUpF8uMuAJOM2pxb1Q",
7  "sub_openid" : "oUpF8uMuAJOM2pxb1Q",
8  "plan_id" : "101164396123311331",
9  "contract_information" : {
10    "contract_id" : "wx998877665544wx",
11    "contract_status" : "ADD",
12    "create_time" : "2020-03-26T10:43:39+08:00"
13  }
14}
15

错误码

公共错误码

状态码	错误码	描述	解决方案
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版)开发者社区微信开放平台微信公众平台腾讯客服