商户订单号查单接口

更新时间:2023.05.12

通过商户订单号查询微信支付订单。

# 接口说明

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

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Path 路径参数
  • out_trade_no 必填 string(64)
    【商户订单号】 商户在调用「扣款接口」时自行生成的订单号,要求64个字符内,只能是数字、大小写字母和_-,且在同一个商户号下唯一。
    Query 查询参数
  • sub_mchid 选填 string(32)
    【子商户号】 微信支付分配的商户号,服务商商户号与子商户号存在父子关系。如果是服务商模式接入则可选;如果是直连商户模式接入则不用填写。

请求示例

GET

# 应答参数

    200OK
  • mchid 必填 string(32)
    【商户号】 微信支付分配的商户号。如果是服务商模式接入则为服务商商户号;如果是直连商户模式接入则为直连商户号。
  • appid 必填 string(32)
    【商户AppID】 微信公众平台(mp.weixin.qq.com)为服务商商户分配的公众账号ID,与商户号存在绑定关系。
    如果是服务商模式接入则为服务商商户号绑定的AppID;如果是直连商户模式接入则为直连商户号绑定的AppID。
  • sub_mchid 选填 string(32)
    【子商户号】 微信支付分配的商户号,服务商商户号与子商户号存在父子关系。如果是服务商模式接入则有值;如果是直连商户模式接入则该字段为空。
  • sub_appid 选填 string(32)
    【子商户AppID】 微信公众平台(mp.weixin.qq.com)为商户分配的公众账号ID,与子商户号存在绑定关系。如果是服务商模式接入则有值;如果是直连商户模式接入则该字段为空。
  • out_trade_no 必填 string(64)
    【商户订单号】 商户自行生成的订单号,要求64个字符内,只能是数字、大小写字母和_-,且在同一个商户号下唯一。
  • transaction_id 选填 string(32)
    【微信支付订单号】 微信支付订单号
  • trade_type 选填 string(16)
    【交易类型】 交易类型,取值如下:JSAPI,NATIVE,APP,MICROPAY,MWEB,FACEPAY
  • trade_state 必填 string(32)
    【交易状态】 本支付订单的状态,可选枚举值:SUCCESS—支付成功;REFUND—转入退款;ACCEPTED—已受理,未支付;PAY_FAIL-支付失败(其他原因,如银行返回失败);PAY_BACK-用户归还欠款(仅当本单由微信支付预先垫付资金,即bank_type=BPA时有可能发生)
  • trade_state_desc 选填 string(256)
    【交易状态描述】 对当前订单状态的描述和下一步操作的指引
  • bank_type 选填 string(16)
    【付款银行】 银行类型,采用字符串类型的银行标识,值列表详见银行类型。特别地,使用BPA表示本笔订单由微信支付预先垫付资金。
  • attach 选填 string(127)
    【商户数据】 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
  • success_time 选填 string(32)
    【支付完成时间】 支付订单已成功才会返回,使用rfc3339所定义的格式,即为YYYY-MM-DDThh:mm:ss+TIMEZONE
  • payer 选填 object
    【支付者】 支付者
    • 属性
  • amount 必填 object
    【订单金额】 订单金额信息
    • 属性
  • device_info 必填 object
    【设备信息】 设备信息
    • 属性
  • promotion_detail 选填 array[object]
    【优惠详情】 优惠详情
    • 属性

应答示例

200 OK

# 错误码

# 公共错误码

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

# 业务错误码

状态码 错误码 描述 解决方案
400 INVALID_REQUEST 非法商户,请确认参数与订单创建商户一致 请确认商户与out_trade_no匹配,服务商模式下还需要确认子商户是否匹配
400 PARAM_ERROR 参数错误,请检查out_trade_no 参数错误,请检查out_trade_no为创建订单时的商户订单号
404 NOT_FOUND 订单不存在 请确认out_trade_no正确且为当前商户的订单
429 RATELIMIT_EXCEEDED 达到调用速率限制 接口调用频率过快,请降低请求频率
反馈
咨询
目录