商户通过商户协议号查询协议API

更新时间:2024.05.24

通过商户协议号查询协议。 直连商户、普通服务商、从业机构服务商、电商收付通服务商均可以通过该接口发起签约协议的查询。 前置条件:商户已经成功获取过免密支付的签约协议。

# 接口说明

支持商户:
【普通商户】
请求方式:
【GET】/v3/password-exempt-contract/contracts/service-id/{service_id}/out-contract-code/{out_contract_code}
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Path 路径参数
  • out_contract_code 必填 string(32)
    【商户签约协议号】 商户侧的签约协议号,商户侧需保证唯一性,同一个协议号解约后无法重复使用。只能是数字、大小写字母的组合。
  • service_id 必填 integer
    【免密支付服务ID】 免密支付服务ID

请求示例

GET

# 应答参数

    200OK
  • mchid 必填 string(32)
    【商户号】 微信支付分配的商户号
  • contract_id 必填 string(32)
    【免密支付协议ID】 免密支付协议的主键,唯一定义此资源的标识
  • appid 必填 string(32)
    【商户AppID】 AppID是商户在微信申请公众号或移动应用成功后分配的账号ID,登录平台为mp.weixin.qq.com或open.weixin.qq.com
  • openid 必填 string(64)
    【用户标识】 商户AppID下的用户唯一标识
  • sub_appid 选填 string(32)
    【子商户AppID】 AppID是商户在微信申请公众号或移动应用成功后分配的账号ID,登录平台为mp.weixin.qq.com或open.weixin.qq.com
  • sub_openid 选填 string(64)
    【用户标识】 子商户AppID下的用户唯一标识
  • service_id 必填 integer
    【免密支付服务ID】 免密支付服务ID
  • out_contract_code 必填 string(32)
    【商户签约协议号】 商户侧的签约协议号。
  • contract_display_account 选填 string
    【用户账户展示名称】 签约用户的名称,用于页面展示,在签约时由商户传入。
  • contract_state 必填 string
    【委托代扣协议状态】 委托代扣协议状态
    可选取值:
    • SIGNED: 签约生效中。
    • TERMINATED: 生效的签约协议已被解约。
  • 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_terminate_info 选填 ContractTerminateInfo
    【协议解约信息】 协议解约信息,仅当contract_state=TERMINATED时,该值有效。
    • 属性

应答示例

200 OK

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 请根据错误提示正确传入参数
400 INVALID_REQUEST HTTP 请求不符合微信支付 APIv3 接口规则 请参阅 接口规则
401 SIGN_ERROR 验证不通过 请参阅 签名常见问题
500 SYSTEM_ERROR 系统异常,请稍后重试 请稍后重试

# 业务错误码

状态码 错误码 描述 解决方案
403 NO_AUTH 商户暂无权限使用此功能 请开通商户号权限。请联系产品申请
反馈
咨询
目录