Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

查询订单API

微信订单号查询订单API

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


该接口提供所有微信支付订单的查询,商户可以通过查询订单接口主动查询订单状态,完成下一步的业务逻辑。
需要调用查询接口的情况:
1. 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;
2. 调用扣款接口后,返回系统错误或未知交易状态情况;

接口说明

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

接口URL:https://apihk.mch.weixin.qq.com/v3/global/papay/transactions/{transaction_id}
           或
           https://apihk.mch.weixin.qq.com/v3/global/papay/transactions/out-trade-no/{out_trade_no}

请求方式:GET

接口规则:https://wechatpay-api.gitbook.io/wechatpay-api-v3/


path 指该参数为路径参数

query 指该参数为URL参数

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

请求参数

参数名 变量 类型[长度限制] 必填 描述
子商户号 sub_mchid string[1,32] query服务商模式必填,微信支付分配的子商户号
注意:仅适用于机构模式
示例值:10000097
微信订单号 transaction_id string[1,32] 二选一 path支付完成后,微信返回的微信支付订单号
示例值:4015463511252015071056489715
商户订单号 out_trade_no string[1,32] path商户系统内部的订单号,可包含字母;更换授权码必须要换新的商户订单号 其他说明见商户订单号
示例值:1217752501201407033233368018

请求示例


https://apihk.mch.weixin.qq.com/v3/global/papay/transactions/4015463511252015071056489715

或

https://apihk.mch.weixin.qq.com/v3/global/papay/transactions/out_trade_no/1217752501201407033233368018

https://apihk.mch.weixin.qq.com/v3/global/papay/transactions/4015463511252015071056489715?sub_mchid=10000097

或

https://apihk.mch.weixin.qq.com/v3/global/papay/transactions/out_trade_no/1217752501201407033233368018?sub_mchid=10000097

返回参数

参数名 变量 类型[长度限制] 必填 描述
商户号 mchid string[1,32] 微信支付分配的商户号
注意:仅适用于直连模式
示例值:10000091
应用ID appid string[1,32] 商户号绑定的appid
注意:仅适用于直连模式
示例值:wxcbda96de0b165486
服务商商户号 sp_mchid string[1,32] 微信支付分配的机构商户号
注意:仅适用于机构模式
示例值:10000098
子商户号 sub_mchid string[1,32] 微信支付分配的子商户号
注意:仅适用于机构模式
示例值:10000097
服务商应用ID sp_appid string[1,32] 服务商绑定的appid
注意:仅适用于机构模式
示例值:wxcbda96de0b165486
子商户应用ID sub_appid string[1,32] 发起签约的子商户号绑定的appid
注意:仅适用于机构模式
示例值:wxcbda96de0b165484
商户订单号 out_trade_no string[1,32] 返回的商户订单号
示例值:1217752501201407033233368018
微信支付订单号 transaction_id string[1,32] 微信支付订单号
示例值:1217752501201407033233368018
商户数据 attach string[1,127] 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
示例值:自定义数据
交易类型 trade_type string[1,16] 代扣支付
示例值:AUTH
付款银行 bank_type string[1,32] 银行类型
示例值:WPHK:香港钱包支付
支付完成时间 success_time string[1,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[1,16] 枚举值:
SUCCESS:支付成功
REFUND:转入退款
NOTPAY:未支付
CLOSED:已关闭
PAYERROR:支付失败
USERPAYING:用户支付中
示例值:SUCCESS
交易状态描述 trade_state_desc string[1,256] 对当前订单状态的描述和下一步操作的指引
示例值:支付失败,请重新下单支付
MCC码 merchant_category_code string[1,16] 商户行业编码
示例值:1011
+支付者 payer object 成功时才返回。支付者信息,详细说明见下文
参数名 变量 类型[长度限制] 必填 描述
用户标识(直连商户) openid string[1,128] 用户在商户appid下的openid
注意:仅适用于直连模式
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6a
用户标识(服务商) sp_openid string[1,128] 用户在商户sp_appid对应下的唯一标识,需要传sp_appid才有返回
注意:仅适用于机构模式
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
用户标识(特约商户) sub_openid string[1,128] 用户在收单行sub_appid下用户唯一标识,需要传sub_appid才有返回
注意:仅适用于机构模式
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+订单金额 amount object 成功时才返回。订单金额信息,详细说明见下文
参数名 变量 类型[长度限制] 必填 描述
订单金额 total int 订单总金额,币种的最小单位,只能为整数,详见交易金额
示例值:888
用户支付金额 payer_total int 用户实际支付金额,币种的最小单位,只能为整数,详见交易金额
示例值:888
订单标价币种 currency string[1,16] 符合ISO 4217标准的三位字母代码
示例值:CNY
用户支付币种 payer_currency string[1,16] 符合ISO 4217标准的三位字母代码
示例值:HKD
+汇率信息 exchange_rate object 汇率信息
参数名 变量 类型[长度限制] 必填 描述
汇率类型 type string[1,16] 枚举值:
SETTLEMENT_RATE:标价币种和结算币种的汇率类型
USERPAYMENT_RATE:标价币种和支付币种的汇率类型
示例值:SETTLEMENT_RATE
汇率值 rate int rate值是兑换比例乘以10的8次方。 如果标价币种和结算币种一致,兑换比例是1,则rate=100000000; 如果标价币种和结算币种不一致,例如美元兑换人民币的比例为6.5,则rate=650000000
示例值:80000000
+场景信息 scene_info object 成功时才返回。场景信息对象,详细说明见下文
参数名 变量 类型[长度限制] 必填 描述
商户端设备 device_id string[1,32] 终端设备号(商户自定义,如门店编号)
示例值:013467007045764
商户端设备IP device_ip string[1,40] 商户侧设备IP,取公网出口IP,支持IPV6
示例值:128.0.0.1
+优惠功能 promotion_detail array 成功时才返回。优惠功能信息,详细说明见下文
参数名 变量 类型[长度限制] 必填 描述
券ID promotion_id string[1,32] 券或者立减优惠id
示例值:109519
优惠名称 name string[1,64] 优惠名称
示例值:单品惠-6
优惠范围 scope string[1,32] GLOBAL:全场代金券
SINGLE:单品优惠
示例值:SINGLE
优惠类型 type string[1,16] COUPON:代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致)
DISCOUNT:优惠券,不走结算资金的免充值型优惠券,(境外商户券币种与标价币种一致
示例值:COUPON
优惠券面额 amount int 用户享受优惠的金额
示例值:5
优惠币种 currency string[1,16] 符合ISO 4217标准的三位字母代码
示例值:HKD
活动ID activity_id string[1,32] 在微信商户后台配置的批次ID
示例值:931386
微信出资 wxpay_contribute_amount int 特指由微信支付商户平台创建的优惠,出资金额等于本项优惠总金额
示例值:5
商户出资 merchant_contribute_amount int 特指商户自己创建的优惠,出资金额等于本项优惠总金额
示例值:5
其他出资 other_contribute_amount int 其他出资方出资金额
示例值:5
+单品列表 goods_detail array 单品信息
参数名 变量 类型[长度限制] 必填 描述
商品编码 goods_id string[1,32] 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成
示例值:124512
商品备注 goods_remark string[1,128] goods_remark为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置
示例值:1001
商品优惠金额 discount_amount int 单品的总优惠金额
示例值:100
商品数量 quantity int 用户购买的数量
示例值:1
商品价格 price int 单位为:分。如果商户有优惠,需传输商户优惠后的单价
示例值:528800

返回示例


{
  "mchid": "10000091",
  "appid": "wxcbda96de0b165486",
  "sp_mchid": "10000098",
  "sub_mchid": "10000097",
  "sp_appid": "wxcbda96de0b165486",
  "sub_appid": "wxcbda96de0b165484",
  "out_trade_no": "1217752501201407033233368018",
  "transaction_id": "1217752501201407033233368018",
  "attach": "自定义数据",
  "trade_type": "AUTH",
  "bank_type": "WPHK:香港钱包支付",
  "success_time": "2018-06-08T10:34:56+08:00",
  "trade_state": "SUCCESS",
  "trade_state_desc": "支付失败,请重新下单支付",
  "merchant_category_code": "1011",
  "payer": {
    "openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6a",
    "sp_openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
    "sub_openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"
  },
  "amount": {
    "total": 888,
    "payer_total": 888,
    "currency": "CNY",
    "payer_currency": "HKD",
    "exchange_rate": {
      "type": "SETTLEMENT_RATE",
      "rate": 80000000
    }
  },
  "scene_info": {
    "device_id": "013467007045764",
    "device_ip": "128.0.0.1"
  },
  "promotion_detail": [
    {
      "promotion_id": "109519",
      "name": "单品惠-6",
      "scope": "SINGLE",
      "type": "COUPON",
      "amount": 5,
      "currency": "HKD",
      "activity_id": "931386",
      "wxpay_contribute_amount": 100,
      "merchant_contribute_amount": 100,
      "other_contribute_amount": 5,
      "goods_detail": {
        "goods_id": "1245454",
        "goods_remark": "1001",
        "discount_amount": 100,
        "quantity": 1,
        "price": 528800
      }
    }
  ]
}
                    

http://2323weixin.qq.com
                    

版本说明

关闭
V1.0
2021年8月15日
1. 微信订单号查询订单API上线

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2024 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global