商户订单号查询订单
更新时间:2024.12.11订单支付成功后,商户可使用微信订单号查询订单或商户订单号查询订单;若订单未支付,则只能使用商户订单号查询订单。
接口说明
支持商户:【普通商户】
请求方式:【GET】/v3/pay/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(32)
【商户订单号】 商户下单时传入的商户系统内部订单号。
query 查询参数
mchid 必填 string(32)
【商户号】商户下单时传入的商户号。
请求示例
GET
应答参数
|
appid 必填 string(32)
【公众账号ID】商户下单时传入的公众账号ID。
mchid 必填 string(32)
【商户号】商户下单时传入的商户号。
out_trade_no 必填 string(32)
【商户订单号】 商户下单时传入的商户系统内部订单号。
transaction_id 选填 string(32)
【微信支付订单号】 微信支付侧订单的唯一标识,订单支付成功后返回。
trade_type 必填 string(16)
【交易类型】 返回当前订单的交易类型,枚举值:
JSAPI:公众号支付、小程序支付
NATIVE:Native支付
APP:APP支付
MICROPAY:付款码支付
MWEB:H5支付
FACEPAY:刷脸支付
trade_state 必填 string(32)
【交易状态】 交易状态,详细业务流转状态处理请参考开发指引-订单状态流转图。枚举值:
SUCCESS:支付成功
REFUND:转入退款
NOTPAY:未支付
CLOSED:已关闭
REVOKED:已撤销(仅付款码支付会返回)
USERPAYING:用户支付中(仅付款码支付会返回)
PAYERROR:支付失败(仅付款码支付会返回)
trade_state_desc 必填 string(256)
【交易状态描述】 对交易状态的详细说明。
bank_type 选填 string(32)
【银行类型】 用户支付方式说明,订单支付成功后返回,格式为银行简码_具体类型(DEBIT借记卡/CREDIT信用卡/ECNY数字人民币),例如ICBC_DEBIT代表工商银行借记卡,非银行卡支付类型(例如余额/零钱通等)统一为OTHERS,具体请参考《银行类型对照表》。
attach 选填 string(128)
【商户数据包】商户下单时传入的自定义数据包,用户不可见,长度不超过128字符,若下单传入该参数,则订单支付成功后此接口和支付成功回调通知以及交易账单中会原样返回;若下单未传该参数,则不会返回。
success_time 选填 string(64)
【支付完成时间】
1、定义:用户完成订单支付的时间。该参数在订单支付成功后返回。
2、格式:遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE
。yyyy-MM-DD
表示年月日;T
字符用于分隔日期和时间部分;HH:mm:ss
表示具体的时分秒;TIMEZONE
表示时区(例如,+08:00
对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00
表示北京时间2015年5月20日13点29分35秒。
payer 选填 object
【支付者】 订单的支付者信息,订单支付成功后返回。
属性 | |
amount 必填 object
【订单金额】 订单金额信息。
属性 | |
scene_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 | 无效请求 | 请根据接口返回的详细信息检查 |
400 | MCH_NOT_EXISTS | 商户号不存在 | 请检查商户号是否正确,商户号获取方式请参考普通商户模式开发必要参数说明 |
401 | SIGN_ERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求,参考:如何生成签名 |
403 | RULE_LIMIT | 业务规则限制 | 因业务规则限制请求频率,请查看接口返回的详细信息 |
403 | TRADE_ERROR | 交易错误 | 因业务原因交易失败,请查看接口返回的详细信息 |
404 | ORDER_NOT_EXIST | 订单不存在 | 请检查商户订单号是否下单成功 |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低请求接口频率 |
500 | SYSTEM_ERROR | 系统错误 | 系统异常,请用相同参数重新调用 |