通过商户协议号查询协议

Header HTTP头参数

Authorization 　必填　string

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

Accept 　必填　string

请设置为application/json

path 路径参数

plan_id 　必填 integer

【委托代扣协议模板ID】 委托代扣协议模板ID

out_contract_code 　必填 string(32)

【商户签约协议号】 商户侧的签约协议号，商户侧需保证唯一性。

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/ecommerce/combine-papay/contracts/plan-id/12535/out-contract-code/wxwtdk20200910100000 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

200 OK

mchid 　必填 string(32)

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

contract_id 　必填 string(32)

【委托代扣协议ID】 委托代扣协议的主键，唯一定义此资源的标识

appid 　必填 string(32)

【商户APPID】 appid是电商服务商在微信公众平台或 开发平台申请的移动应用成功后分配的账号ID

plan_id 　必填 integer

【委托代扣协议模板ID】 委托代扣协议模板ID

out_contract_code 　必填 string(32)

【商户签约协议号】 商户侧的签约协议号，商户侧需保证唯一性。

contract_display_account 　必填 string(32)

【用户账户展示名称】 签约用户的名称，用于页面展示，在签约时由商户传入。

contract_state 　必填 string

【委托代扣协议状态】 委托代扣协议状态

可选取值

• NOT_SIGNED: 未签约。

• SIGNED: 已签约。

• TERMINATED: 已解约。

contract_signed_time 　必填 string(32)

【协议签署时间】 协议签署时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒

contract_expired_time 　必填 string(32)

【协议到期时间】 协议到期时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒

contract_terminate_info 　选填 object

【协议解约信息】 协议解约信息，仅当contract_state=TERMINATED时，该值有效。

属性

contract_termination_mode 　必填 string(32) 【协议解约方式】 协议解约方式 可选取值 USER_TERMINATE: 用户主动解约 MCH_API_TERMINATE: 商户通过API发起的解约 WEPAY_WEB_TERMINATE: 商户在商户平台发起的解约 CUSTOM_SERVICE_TERMINATE: 用户联系微信支付客服发起的解约 SYSTEM_TERMINATE: 微信支付系统主动发起的解约 contract_terminated_time 　必填 string(32) 【协议解约时间】 按照使用rfc3339所定义的格式，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒 contract_termination_remark 　必填 string(128) 【解约备注】 解约原因的备注说明，如：签约信息有误，须重新签约。

openid 　必填 string(64)

【用户openID】 商户APPID下的用户唯一标识

应答示例

200 OK

1{
2  "mchid" : "1900000109",
3  "contract_id" : "123124412412423431",
4  "appid" : "wxd678efh567hg6787",
5  "plan_id" : 12535,
6  "out_contract_code" : "wxwtdk20200910100000",
7  "contract_display_account" : "微信代扣用户A",
8  "contract_state" : "NOT_SIGNED",
9  "contract_signed_time" : "2020-09-10T13:29:35.120+08:00",
10  "contract_expired_time" : "2021-09-10T13:29:35.120+08:00",
11  "contract_terminate_info" : {
12    "contract_termination_mode" : "USER_TERMINATE",
13    "contract_terminated_time" : "2020-10-10T13:29:35.120+08:00",
14    "contract_termination_remark" : "用户解约"
15  },
16  "openid" : "o-MYE42l80oelYMDE34nYD456Xoy"
17}
18