代扣协议ID查询签约API
更新时间:2025.01.07查询签约关系接口提供单笔签约关系查询, 查询方式:使用微信返回的委托代扣协议contract_id进行查询。
1. 接口说明
适用对象: 直连模式 机构模式
请求URL:https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/{contract_id}
请求方式:GET
Path 指该参数为路径参数
Query 指该参数为URL参数
Body 指该参数需在请求JSON传参
2. 请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
应用ID | appid | string[1, 32] | 是 | Query 商户号绑定的appid |
子商户号 | sub_mchid | string[1,32] | 是 | Query 微信支付分配的子商户号 |
服务商应用ID | sp_appid | string[1,32] | 是 | Query 服务商绑定的appid |
子商户应用ID | sub_appid | string[1,32] | 否 | Query 发起签约的子商户号绑定的appid |
委托代扣协议ID | contract_id | string[1,64] | 是 | Path 委托代扣签约成功后由微信返回的委托代扣协议id,选择contract_id查询,则此参数必填 |
请求示例
场景一:直连模式
场景二:服务商模式/机构模式
3. 返回参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商户号 | mchid | string[1,32] | 是 | 微信支付分配的商户号 |
应用ID | appid | string[1,32] | 是 | 商户号绑定的appid |
服务商商户号 | sp_mchid | string[1,32] | 是 | 微信支付分配的机构商户号 |
子商户号 | sub_mchid | string[1,32] | 是 | 微信支付分配的子商户号 |
服务商应用ID | sp_appid | string[1,32] | 是 | 服务商公众号的appid |
子商户应用ID | sub_appid | string[1,32] | 否 | 发起签约的子商户小程序appid |
委托代扣协议ID | contract_id | string[1,64] | 是 | 签约成功后,微信返回的委托代扣协议id |
模板ID | plan_id | int | 是 | 商户向微信支付申请代扣权限时,微信支付将会为商户分配一个唯一的代扣模板ID |
签约协议号 | out_contract_code | string[1,32] | 是 | 商户请求签约时传入的签约协议号,商户侧须唯一 |
用户账户展示名称 | user_display_name | string[1,32] | 是 | 签约用户的名称,用于页面展示 |
协议状态 | state | string[1,32] | 是 | 签约状态 |
协议签署时间 | signed_time | string[1,64] | 是 | 协议签署时间 |
协议解约时间 | terminated_time | string[1,64] | 否 | 当state=NOT SIGNED时,该值表示协议解约时间 |
协议解约方式 | termination_mode | object | 否 | 解约方式 |
解约备注 | termination_note | string[1,256] | 否 | 当state=NOT SIGNED时,该值表示解约备注 |
商户appid下的用户标识 | openid | string[1,128] | 是 | 用户在商户appid下的openid,服务商模式为子商户下的用户openid |
返回示例
场景一:直连模式
场景二:服务商模式/机构模式
4. 错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
403 | CONTRACT_NOT_EXIST | Result Empty | 查询的签约协议不存在,或者传入正确查询参数重试 |
400 | PARAM_ERROR | 参数错误 | 传入正确查询参数 |
500 | SYSTEM_ERROR | 系统错误 | 请稍等重试 |