通过商户协议号查询委托代扣签约协议

Header HTTP头参数

Authorization 　必填　string

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

Accept 　必填　string

请设置为application/json

path 路径参数

out_contract_code 　必填 string(32)

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

plan_id 　必填 integer

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

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/papay/sign/contracts/harmony-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，登录平台为mp.weixin.qq.com或open.weixin.qq.com

plan_id 　必填 integer

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

out_contract_code 　必填 string(32)

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

contract_display_account 　必填 string(64)

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

contract_state 　必填 string

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

可选取值

• SIGNED: 签约生效中。

• TERMINATED: 生效的签约协议已被解约。

• SIGN_FAILED: 用户同意签约但因业务规则限制导致签约失败。如：签约并完成首期支付场景，没有完成首期支付。

• TO_BE_RENEWED: 可续期的计划，等待商户传入续期计划。

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年5月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年5月20日 13点29分35秒

openid 　必填 string(64)

【用户OpenID】 商户AppID下的用户唯一标识

contract_terminate_info 　选填 object

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

属性

contract_termination_mode 　必填 string 【协议解约方式】 协议解约方式 可选取值 USER_TERMINATE: 用户发起的解约 MCH_API_TERMINATE: 商户通过API发起的解约 WEPAY_WEB_TERMINATE: 商户在商户平台发起的解约 CUSTOMER_SERVICE_TERMINATE: 用户联系微信支付客服发起的解约 SYSTEM_TERMINATE: 微信支付系统主动发起的解约 contract_terminated_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年5月20日 13点29分35秒 contract_termination_remark 　选填 string 【解约备注】 解约原因的备注说明，如：签约信息有误，须重新签约。

out_user_code 　选填 string

【商户侧用户标识】 在多账号签约场景下使用。一个用户微信账号可能会在商户系统中存在多个账号，并开通多个签约协议。商户可以使用商户侧用户标识区分商户系统中的不同用户账号。注：使用多账号签约规则时，微信支付系统将限制相同的商户侧用户标识只能与同一个委托代扣模板签署一份生效中的协议。

mask_wxid 　选填 string

【鸿蒙代扣场景的用户微信号掩码】 仅当鸿蒙代扣场景，该值才有效。

应答示例

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" : "SIGNED",
9  "contract_signed_time" : "2020-09-10T13:29:35+08:00",
10  "contract_expired_time" : "2021-09-10T13:29:35+08:00",
11  "openid" : "o-MYE42l80oelYMDE34nYD456Xoy",
12  "contract_terminate_info" : {
13    "contract_termination_mode" : "MCH_API_TERMINATE",
14    "contract_terminated_time" : "2020-10-10T13:29:35+08:00",
15    "contract_termination_remark" : "用户解约"
16  },
17  "out_user_code" : "用户A",
18  "mask_wxid" : "example_mask_wxid"
19}
20