查询签约关系

应用场景

查询签约关系接口提供单笔签约关系查询:

  1. 查询方式一:使用微信返回的委托代扣协议contract_id进行查询
  2. 查询方式二:plan_id+contract_code模式:传入模板id和委托代扣协议号进行查询

 

接口调用请求说明

请求Url https://api.mch.weixin.qq.com/papay/querycontract
是否需要证书
请求方式 post

 

请求参数

字段名 变量名 必填 类型 示例值 说明

请求appid

appid

String(18)

wxcbda96de0b165486

appid是商户在微信申请公众号或移动应用成功后分配的帐号ID,登录平台为mp.weixin.qq.com或open.weixin.qq.com

商户号

mch_id

int

10000098

商户号是商户在微信申请微信支付成功后分配的帐号ID,登录平台为pay.weixin.qq.com

委托代扣协议id

contract_id

String(32)

100005698

委托代扣签约成功后由微信返回的委托代扣协议id,选择contract_id查询,则此参数必填

模板id

plan_id

int

123

商户在微信商户平台配置的代扣模版id,选择plan_id+contract_code查询,则此参数必填

签约协议号

contract_code

string

1023658866

商户请求签约时传入的签约协议号,商户侧须唯一。选择plan_id+contract_code查询,则此参数必填

版本号

version

string

1.0

固定值1.0

签名

sign

string

E1EE61A91C8E90F299DE6AE075D60A2D

签名规则详见签名生成算法

数据示例(以contract_id查询模式为例):

<xml>
 <sign>019C869758CC7F258C42F05CDB9EE361</sign>
 <mch_id>10000097</mch_id>
 <appid>wxf5b5e87a6a0fde94</appid>
 <contract_id>201509160000028648</contract_id>
 <version>1.0</version>

</xml>

返回参数

字段名 变量名 必填 示例值 类型 说明

返回状态码

return_code

SUCCESS

String(16)

SUCCESS/FAIL
此字段是通信标识,非业务标识,业务是否成功需要查看result_code来判断

返回信息

return_msg

 

String(128)

返回信息,如非空,为错误原因
如:
签名失败
参数格式校验错误等

以下字段在return_code为SUCCESS的时候返回

业务结果

result_code

SUCCESS

String(16)

SUCCESS/FAIL

以下字段在return_code 和result_code都为SUCCESS的时候有返回

商户号

mch_id

10000098

int

微信支付分配的商户号

公众账号id

appid

wxcbda96de0b165486

String(32)

微信支付分配的公众账号id

委托代扣协议id

contract_id

100005698

String(32)

签约成功后,微信返回的委托代扣协议id

模板id

plan_id

123

Int

商户在微信商户平台设置的代扣协议模板id

请求序列号

request_serial

1695

Uint64

商户请求签约时的序列号,商户侧须唯一,纯数字。长度不超过12位

签约协议号

contract_code

1023658866

String

商户请求签约时传入的签约协议号,商户侧须唯一

用户账户展示名称

contract_display_account

张三

String

签约用户的名称,用于页面展示

协议状态

contract_state

1

int

0-已签约 
1-未签约
9-签约进行中

协议签署时间

contract_signed_time

2015-07-01 10:00:00

String

协议签署时间

协议到期时间

contract_expired_time

2016-07-01 10:00:00

String

协议到期时间

协议解约时间

contract_terminated_time

2015-09-01 10:00:00

String

当contract_state=1时,该值有效

协议解约方式

contract_termination_mode

3

int

当contract_state=1时,该值有效
0-未解约
1-有效期过自动解约
2-用户主动解约
3-商户API解约
4-商户平台解约
5-注销

签名

sign

C380BEC2BFD727A4B6845133519F3AD6

String(32)

详见签名生成算法

解约备注

contract_termination_remark

解约原因

String

当contract_state=1时,该值有效

用户标识

openid

ozoKAt9TIPHfwVMkcniiNKZ1vbyw

String

商户appid下的用户唯一标识

>以下字段在result_code为FAIL的时候有返回

错误代码

err_code

SIGN_ERROR

String(32)

错误码

错误代码描述

err_code_des

签名错误

String(32)

错误码描述

 

示例:

<xml>
<return_code> <![CDATA[SUCCESS]]> </return_code>
<result_code> <![CDATA[SUCCESS]]> </result_code>
<mch_id> <![CDATA[80000000]]> </mch_id>
<appid> <![CDATA[wx426b3015555b46be]]> </appid>
<contract_id>203</contract_id>
<plan_id>66</plan_id>
<openid> <![CDATA[oHZx6uMbIG46UXQ3SKxVYEgw1LZs]]> </openid>
<request_serial>123</request_serial>
<contract_code> <![CDATA[1005]]> </contract_code>
<contract_display_account> <![CDATA[test]]> </contract_display_account>
<contract_state>1</contract_state>
<contract_signed_time>1438141845</contract_signed_time>
<contract_expired_time>1453953047</contract_expired_time>
<contract_terminated_time>1438157486</contract_terminated_time>
<contract_termination_mode>3</contract_termination_mode>
<contract_termination_remark> <![CDATA[delete ....]]> </contract_termination_remark>
<err_code>0</err_code>
<err_code_des> <![CDATA[SUCCESS]]> </err_code_des>
<sign> <![CDATA[8FC9DACB7DDF9B48333DCCC2224E0CAC]]> </sign>

</xml>

错误码

错误码

描述

解决方案

SIGN_ERROR

签名错误

验证签名算法

PARAMETER FAIL

参数错误

验证参数

XML FAIL

XML格式错误

检查XML格式

RESULT NULL

查询为空

传入正确查询参数

-48

MERCHANT PERMISSION ERROR

确认商户权限(包含appid和mchid绑定关系)

25

查询签约关系不存在

确认签约关系