查询微工卡授权关系

更新时间:2024.12.27

查询商户和微信支付用户的微工卡授权关系

# 接口说明

支持商户:
【普通服务商】
请求方式:
【GET】/v3/payroll-card/relations/{openid}
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Path 路径参数
  • openid 必填 string(64)
    【用户OpenID】 微信用户OpenID
    Query 查询参数
  • sub_mchid 必填 string(32)
    【特约商户号】 特约商户号
  • appid 选填 string(32)
    【服务商AppID】 当输入服务商AppID时会校验其与服务商商户号绑定关系。
    服务商AppID和特约商户AppID至少输入一个。
  • sub_appid 选填 string(32)
    【特约商户AppID】 当输入特约商户AppID时会校验其与特约商户号关系。
    特约商户AppID和服务商AppID至少输入一个。

请求示例

GET

# 应答参数

    200OK
  • openid 必填 string(64)
    【用户OpenID】 用户OpenID
  • mchid 必填 string(32)
    【商户号】 商户号
  • sub_mchid 必填 string(32)
    【特约商户号】 特约商户号
  • authorize_state 必填 string(32)
    【授权状态】 授权状态:UNAUTHORIZED:未授权 AUTHORIZED:已授权 DEAUTHORIZED:已取消授权
  • authorize_time 选填 string(32)
    【授权时间】 授权时间
  • deauthorize_time 选填 string(32)
    【取消授权时间】 取消授权时间,遵循RFC3339标准格式,格式为yyyy-MM-DDThh:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。
  • register_state 必填 string
    【开通状态】 微工卡的开通状态:UNREGISTERED:未开通;REGISTERED:已开通;CLOSED:已关闭
    可选取值:
    • UNDEFINED: 未定义状态
    • UNREGISTERED: 未开通
    • REGISTERED: 已开通
    • CLOSED: 已关闭
  • register_time 选填 string(32)
    【开通时间】 开通时间,未开通时不返回。遵循RFC3339标准格式,格式为yyyy-MM-DDThh:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。
  • close_time 选填 string(32)
    【关闭时间】 关闭时间,仅当开通状态是已关闭时返回。遵循RFC3339标准格式,格式为yyyy-MM-DDThh:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。

应答示例

200 OK

# 错误码

# 公共错误码

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

# 业务错误码

状态码 错误码 描述 解决方案
400 PARAM_MISSING 参数缺失 参考API文档要求输入参数(AppID和sub_appid必填一个)
400 PARAM_ILLEGAL 参数值不合法 参考API文档要求输入参数
401 MCH_TICKET_ILLEGAL 服务商票据校验失败 参考API文档要求输入正确服务商或特约商户
400 AUTH_ERROR 校验身份或者产品权限失败 参考API文档要求输入参数,MA关系必须匹配, 服务商需有产品受理权限
403 MERCHANT_INFO_ERROR 获取商户信息失败 获取商户信息失败,请重试
403 AUTH_INFO_ERROR 获取授权信息失败 获取授权信息失败,请重试
反馈
咨询
目录

微信支付文档中心已升级,你当前所查看的是旧文档中心的内容,旧文档中心将于 2025年 3 月 31日 下线,请移步 [新文档中心] 查看相应的内容