商户协议号查询签约API
最新更新时间：2022.08.04 版本说明
查询签约关系接口提供单笔签约关系查询， 查询方式：plan_id + out_contract_no模式：传入模板ID和委托代扣协议号进行查询。
注意： • 商户上送敏感信息时使用微信支付平台公钥加密，证书序列号包含在请求HTTP头部的Wechatpay-Serial，详见接口规则
注意： 1. 接口说明
适用对象： 直连模式 机构模式
请求URL：https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/out-contract-code/{out_contract_code}
请求方式：GET
Path指该参数为路径参数
Query指该参数为URL参数
Body指该参数需在请求JSON传参
2. 请求参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 应用ID | appid | string[1, 32] | 是 | Query商户号绑定的appid 注意：仅适用于直连模式 示例值：wxcbda96de0b165486 |
| 子商户号 | sub_mchid | string[1,32] | 是 | Query微信支付分配的子商户号 注意：仅适用于机构模式 示例值：10000097 |
| 服务商应用ID | sp_appid | string[1,32] | 是 | Query服务商绑定的appid 注意：仅适用于机构模式 示例值：wxcbda96de0b165486 |
| 子商户应用ID | sub_appid | string[1,32] | 否 | Query发起签约的子商户号绑定的appid 注意：仅适用于机构模式 示例值：wxcbda96de0b165484 |
| 模板ID | plan_id | int | 是 | Query商户向微信支付申请代扣权限时，微信支付将会为商户分配一个唯一的代扣模板ID，选择plan_id+out_contract_no查询，则此参数必填 示例值：123 |
| 签约协议号 | out_contract_code | string[1,32] | 是 | Path商户请求签约时传入的签约协议号，商户侧须唯一。选择plan_id+out_contract_no查询，则此参数必填 示例值：1023658866 |
请求示例
https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/out-contract-code/100005698?appid=wxcbda96de0b165486&plan_id=123
3. 返回参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 商户号 | mchid | string[1,32] | 是 | 微信支付分配的商户号 注意：仅适用于直连模式 示例值：10000091 |
| 应用ID | appid | string[1,32] | 是 | 商户号绑定的appid 注意：仅适用于直连模式 示例值：wxcbda96de0b165486 |
| 服务商商户号 | sp_mchid | string[1,32] | 是 | 微信支付分配的机构商户号 注意：仅适用于机构模式 示例值：10000098 |
| 子商户号 | sub_mchid | string[1,32] | 是 | 微信支付分配的子商户号 注意：仅适用于机构模式 示例值：10000097 |
| 服务商应用ID | sp_appid | string[1,32] | 是 | 服务商公众号的appid 注意：仅适用于机构模式 示例值：wxcbda96de0b165486 |
| 子商户应用ID | sub_appid | string[1,32] | 否 | 发起签约的子商户小程序appid 注意：仅适用于机构模式 示例值：wxcbda96de0b165484 |
| 委托代扣协议ID | contract_id | string[1,64] | 是 | 签约成功后，微信返回的委托代扣协议id 示例值：100005698 |
| 模板ID | plan_id | int | 是 | 商户向微信支付申请代扣权限时，微信支付将会为商户分配一个唯一的代扣模板ID 示例值：123 |
| 签约协议号 | out_contract_code | string[1,32] | 是 | 商户请求签约时传入的签约协议号，商户侧须唯一 示例值：1023658866 |
| 用户账户展示名称 | user_display_name | string[1,32] | 是 | 签约用户的名称，用于页面展示 示例值：张三 |
| 协议状态 | state | string[1,32] | 是 | 签约状态 NOTSIGN：未签约 SIGNING：签约中 SIGNED：已签约 TERMINATING：解约中 TERMINATED：已解约 DELETE：已删除 SIGNFAIL：签约失败 示例值：SIGNED |
| 协议签署时间 | signed_time | string[1,64] | 是 | 协议签署时间 示例值：2015-07-01T10:00:00+08:00 |
| 协议解约时间 | terminated_time | string[1,64] | 否 | 当state=NOT SIGNED时，该值表示协议解约时间 示例值：2015-09-01T10:00:00+08:00 |
| 协议解约方式 | termination_mode | object | 否 | 解约方式 USER：用户解约 MERCHANT：商户解约 PLATFORM：商户平台解约 示例值：USER |
| 解约备注 | termination_note | string[1,256] | 否 | 当state=NOT SIGNED时，该值表示解约备注 示例值：解约原因 |
| 商户appid下的用户标识 | openid | string[1,128] | 是 | 用户在商户appid下的openid，服务商模式为子商户下的用户openid 示例值：ouFhd5X9s9WteC3eWRjXV3lea123 |
返回示例
{
"mchid": "10000100",
"appid": " wx426b3015555b46be ",
"contract_id": "203",
"plan_id": 66,
"openid": " oHZx6uMbIG46UXQ3SKxVYEgw1LZs ",
"out_contract_code": " 1005 ",
"user_display_name": " test ",
"state": "TERMINATED",
"signed_time": "2015-07-01T10:00:00+08:00",
"terminated_time": "2015-09-01T10:00:00+08:00",
"termination_mode": "USER",
"termination_note": " delete ...."
}
4. 错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 403 | CONTRACT_NOT_EXIST | Result Empty | 查询的签约协议不存在，或者传入正确查询参数重试 |
| 400 | PARAM_ERROR | 参数错误 | 传入正确查询参数 |
| 500 | SYSTEM_ERROR | 系统错误 | 请稍等重试 |
页面导航
