Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

查询订单

最新更新时间:2020.1.08 版本说明


该接口提供所有微信支付订单的查询,商户可以通过查询订单接口主动查询订单状态,完成下一步的业务逻辑。

注意:

需要调用查询接口的情况:


● 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;

● 调用支付接口后,返回系统错误或未知交易状态情况;

● 调用刷卡支付API,返回USERPAYING的状态;

● 调用刷卡支付API,返回USERPAYING的状态;


接口说明

适用对象:直连模式机构模式

请求URL: https://api.mch.weixin.qq.com/hk/v3/transactions/id/{id}
                 或
                 https://api.mch.weixin.qq.com/hk/v3/transactions/out-trade-no/{out_trade_no}

请求方式: GET

接口规则: https://wechatpay-api.gitbook.io/wechatpay-api-v3/wei-xin-zhi-fu-api-v3-jie-kou-gui-fan


path 指该参数为路径参数

query 指该参数为URL参数

body 指该参数需在请求JSON传参

请求参数

参数名 变量 类型 必填 描述
商户号 mchid string(32) query 微信支付分配的商户号
注意:仅适用于直连模式
示例值:1900000109
子商户号 sub_mchid string(32) query 微信支付分配的子商户号
注意:仅适用于机构模式
示例值:1900000109
机构商户号 sp_mchid string(32) query 微信支付分配的机构商户号
注意:仅适用于机构模式
示例值:1900000100
商户订单号 out_trade_no string(32) 二选一 path返回的商户订单号
示例值:1217752501201407033233368018
微信支付订单号 id string(32) path微信支付订单号
示例值:4200000000002104083200000488

请求示例:


使用微信支付订单号查单示例:
https://api.mch.weixin.qq.com/hk/v3/transactions/id/4200000000002104083200000488?mchid=1900000109

使用商户订单号查单示例:
https://api.mch.weixin.qq.com/hk/v3/transactions/out-trade-no/1217752501201407033233368018?sub_mchid =1900000109&sp_mchid =1900000100

    
{
JAVA示例代码
}
    

返回参数

正常返回

参数名 变量 类型 必填 描述
商户号 mchid string(32) 微信支付分配的商户号
注意:仅适用于直连模式
示例值:1900000109
APPID appid string(32) 商户在微信公众平台申请服务号对应的APPID
注意:仅适用于直连模式
示例值:wx8888888888888888
机构商户号 sp_mchid string(32) 微信支付分配的机构商户号
注意:仅适用于机构模式
示例值:1900000100
子商户号 sub_mchid string(32) 微信支付分配的子商户号
注意:仅适用于机构模式
示例值:1900000109
机构APPID sp_appid string(32) 机构在微信公众平台申请服务号对应的APPID
注意:仅适用于机构模式
示例值:wx8888888888888888
子商户APPID sub_appid string(32) 子商户在微信开放平台申请移动应用对应的APPID
注意:仅适用于机构模式
示例值:wx8888888888888888
商户订单号 out_trade_no string(32) 返回的商户订单号
示例值:1217752501201407033233368018
微信支付订单号 id string(32) 微信支付订单号
示例值:4200000000002104083200000488
商户数据 attach string(127) 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
示例值:自定义数据
交易类型 trade_type string(16) APP支付
示例值:APP
付款银行 bank_type string(32) 银行类型,采用字符串类型的银行标识,值列表详见银行类型
示例值:CMC
支付完成时间 success_time string(64) 订单支付成功时间,格式为rfc3339格式,如2018-06-08T10:34:56+08:00 代表北京时间2018年06月08日10时34分56秒
示例值:2018-06-08T10:34:56+08:00
交易状态 trade_state string(32) SUCCESS—支付成功
REFUND—转入退款
NOTPAY—未支付
CLOSED—已关闭
REVOKED—已撤销(刷卡支付)
USERPAYING--用户支付中
PAYERROR--支付失败(其他原因,如银行返回失败)
示例值:SUCCESS
交易状态描述 trade_state_desc string(256) 对当前订单状态的描述和下一步操作的指引
示例值:支付失败,请重新下单支付
+支付者 payer object 支付者信息,详细说明见下文
参数名 变量 类型 必填 描述
用户标识 openid string(128) 用户在商户appid对应下的唯一标识,需要传appid才有返回
注意:仅适用于直连模式
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
机构用户标识 sp_openid string(128) 用户在商户sp_appid对应下的唯一标识,需要传sp_appid才有返回
注意:仅适用于机构模式
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
子商户用户标识 sub_openid string(128) 用户在商户sub_appid下用户唯一标识,需要传sub_appid才有返回
注意:仅适用于机构模式
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ 订单金额 amount object 订单金额信息,详细说明见下文
参数名 变量 类型 必填 描述
订单金额 total int 订单总金额,币种的最小单位,只能为整数,详见交易金额
示例值:888
用户支付金额 payer_total int 用户实际支付金额,币种的最小单位,只能为整数,详见交易金额
示例值:888
订单标价币种 currency string(16) 符合ISO 4217标准的三位字母代码
示例值:CNY
用户支付币种 payer_currency string(16) 符合ISO 4217标准的三位字母代码
示例值:HKD
+ 汇率信息 exchange_rate object 汇率信息对象,详细说明见下文
参数名 变量 类型 必填 描述
汇率类型 type string(32) SETTLEMENT_RATE,即标价币种和结算币种的汇率
示例值:SETTLEMENT_RATE
汇率值 rate int rate值是兑换比例乘以10的8次方。
如果标价币种和结算币种一致,兑换比例是1,则rate=100000000;
如果标价币种和结算币种不一致,例如美元兑换人民币的比例为6.5,则rate=650000000
示例值:80000000
+ 优惠功能 promotion_detail array 优惠功能信息,详细说明见下文
参数名 变量 类型 必填 描述
券ID promotion_id string(32) 券或者立减优惠id
示例值:109519
优惠名称 name string(64) 优惠名称
示例值:单品惠-6
优惠范围 scope string(32) GLOBAL- 全场代金券
SINGLE- 单品优惠
示例值:SINGLE
优惠类型 type string(32) COUPON- 代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致)
DISCOUNT- 优惠券,不走结算资金的免充值型优惠券,(境外商户券币种与标价币种一致
示例值:DISCOUNT
优惠券面额 amount int 用户享受优惠的金额
示例值:5
优惠币种 currency string(16) 符合ISO 4217标准的三位字母代码
示例值:HKD
活动ID activity_id string(32) 在微信商户后台配置的批次ID
示例值:931386
微信出资 wxpay_contribute_amount int 特指由微信支付商户平台创建的优惠,出资金额等于本项优惠总金额
示例值: 0
商户出资 merchant_contribute_amount int 特指商户自己创建的优惠,出资金额等于本项优惠总金额
示例值:0
其他出资 other_contribute_amount int 其他出资方出资金额
示例值:5
+ 单品列表 goods_detail Array 单品信息,使用Json格式
参数名 变量 类型 必填 描述
商品编码 goods_id string(32) 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成
示例值:12345
商品备注 goods_remark string(128) goods_remark为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置。
示例值:1001
商品优惠金额 discount_amount int 单品的总优惠金额
示例值:100
商品数量 quantity int 用户购买的数量
示例值:1
商品价格 price int 如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔100元的订单使用了商场发的纸质优惠券100-50,则活动商品的单价应为原单价-50)
示例值:528800

异常返回

参数名 变量 类型 必填 描述
返回状态码 code string(32) 错误码,枚举值见错误码列表
示例值:INVALID_REQUEST
返回信息 message string(256) 返回信息,如非空,为错误原因
示例值:参数格式校验错误
+ 详细的错误描述 detail object 当code为PARAM_ERROR时返回,详细说明见下
参数名 变量 类型 必填 描述
指示错误参数的位置 field string(256) 当错误参数位于请求body的JSON时,填写指向参数的JSON Pointer;
当错误参数位于请求的url或者querystring时,填写参数的变量名
示例值:#/properties/payer
错误参数的值 value string(256) 错误参数的值
示例值:1346177081915535577
具体错误原因 issue string(256) 具体错误原因
示例值:与ALLOF schema不符
错误参数的位置 location string(256) body:错误参数位于请求body的JSON中
url:错误参数位于请求url中
query:错误参数位于请求的querystring中
示例值:body

返回示例:

{
    "id": "4200000000002104083200000488",
    "sp_appid": "wx2421b1c4370ec43b",
    "sp_mchid": "10000100",
    "sub_mchid": "20000100",
    "out_trade_no": "20150806125346",
    "payer": {
      "sp_openid": "oUpF8uN95-Ptaags6E_roPHg7AG0"
    },
    "amount" : {
        "total": 528800,
        "currency": "HKD",
        "payer_total": 518799,
        "payer_currency": "CNY",

        "exchange_rate" : {
            "type": "SETTLEMENT_RATE",
            "rate": 8000000
        }
    }, 
    "trade_type": "APP",
    "trade_state": "SUCCESS",
    "trade_state_desc": "支付成功",
    "bank_type": "CCB_DEBIT",
    "attach": "支付测试",
    "success_time": "2018-06-08T10:34:56+08:00",
    "promotion_detail":[
        {
            "promotion_id":"109519",
            "name":"单品惠-6",
            "scope":"SINGLE",
            "type":"DISCOUNT",
            "amount":1,
            "currency":"HKD",
            "activity_id":"931386",
            "wechatpay_contribute_amount":1,
            "merchant_contribute_amount":0,
            "other_contribute_amount":0,
            "goods_detail":[
                {
                    "goods_id":"iphone6s_16G",
                    "goods_remark":"商品备注",
                    "quantity":1,
                    "price":528800
                }
            ]
        }
    ]
}
{
"code":"INVALID_REQUEST",
"message":"参数格式校验错误",
"detail":{
    "field":"#/properties/payer",
    "value":"1346177081915535577",
    "issue":"与ALLOF schema不符",
    "location":"body"
   }
}

错误码

错误码 描述 解决方案
ORDER_NOT_EXIST 此交易订单号不存在 该API只能查提交支付交易返回成功的订单,请商户检查需要查询的订单号是否正确
SYSTEMERROR 系统错误 系统异常,请再调用发起查询


版本说明

关闭
V1.0
2020年1月08日
1. 查询订单接口上线

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2022 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global