查询签约关系api

https://api.mch.weixin.qq.com/papay/partner/querycontract

否

post

请求appid

appid

是

String(18)

wxcbda96de0b165486

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

子商户公众账号ID

sub_appid

否

String(32)

wxcbda96de0b165489

微信分配的子商户公众账号ID

商户号

mch_id

是

int

10000098

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

子商户号

sub_mch_id

是

String(32)

1900000109

微信支付分配的子商户号

委托代扣协议id

contract_id

否

String(32)

100005698

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

模板id

plan_id

否

int

123

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

签约协议号

contract_code

否

string(128)

1023658866

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

版本号

version

是

string

1.0

固定值1.0

签名

sign

是

string

E1EE61A91C8E90F299DE6AE075D60A2D

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

返回状态码

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

微信支付分配的商户号

子商户号

sub_mch_id

是

1900000109

String(32)

微信支付分配的子商户号

公众账号id

appid

是

wxcbda96de0b165486

String(32)

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

子商户公众账号ID

sub_appid

否

wxcbda96de0b165489

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(128)

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

用户账户展示名称

contract_display_account

是

张三

String(128)

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

协议状态

contract_state

是

1

int

0-已签约 
1-未签约

协议签署时间

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(512)

当contract_state=1时，该值有效

用户标识

openid

是

ozoKAt9TIPHfwVMkcniiNKZ1vbyw

String

商户appid下的用户唯一标识

用户子标识

sub_openid

否

oUpF8uMuAJO_M2pxb1Q9zNjWeS6o

String(32)

sub_appid下，用户的唯一标识

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

错误代码

err_code

是

SIGN_ERROR

String(32)

错误码

错误代码描述

err_code_des

是

签名错误

String(32)

错误码描述

SIGN_ERROR

签名错误

验证签名算法

PARAMETER FAIL

参数错误

验证参数

XML FAIL

XML格式错误

检查XML格式

RESULT NULL

查询为空

传入正确查询参数

MERCHANT PERMISSION ERROR

商户没有权限

确认商户权限