查询订单api-微信合单支付文档(2.0)

微信支付 文章 2020-03-24 13:16 1507 0 全屏看文

AI助手支持GPT4.0

查询订单

应用场景

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

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

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

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

  3. ◆ 调用付款码支付API,返回USERPAYING的状态;

  4. ◆ 调用关单或撤销接口API之前,需确认支付状态;

接口链接

URL地址:https://api.mch.weixin.qq.com/pay/orderquery

URL地址:https://api2.mch.weixin.qq.com/pay/orderquery(备用域名)见跨城冗灾方案

是否需要证书

不需要

请求参数

字段名变量名必填类型示例值描述
公众账号IDappidString(32)wxd678efh567hg6787微信支付分配的公众账号ID(企业号corpid即为此appId)
商户号mch_idString(32)1230000109微信支付分配的商户号
微信订单号transaction_id二选一String(32)1009660380201506130728806387微信的订单号,建议优先使用
商户订单号out_trade_noString(32)20150806125346商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 详见商户订单号
随机字符串nonce_strString(32)C380BEC2BFD727A4B6845133519F3AD6随机字符串,不长于32位。推荐随机数生成算法
签名signString(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS通过签名算法计算得出的签名值,详见签名生成算法
签名类型sign_typeString(32)HMAC-SHA256签名类型,目前支持HMAC-SHA256和MD5,默认为MD5

举例如下:

<xml>
                  <appid>wx2421b1c4370ec43b</appid>
                  <mch_id>10000100</mch_id>
                  <nonce_str>ec2316275641faa3aacf3cc599e8730f</nonce_str>
                  <transaction_id>1008450740201411110005820873</transaction_id>
                  <sign>FDD167FAA73459FD921B144BAF4F4CA2</sign>
               </xml>

返回结果

字段名变量名必填类型示例值描述
返回状态码return_codeString(16)SUCCESS

SUCCESS/FAIL

此字段是通信标识,非交易标识,交易是否成功需要查看trade_state来判断

返回信息return_msgString(128)OK

当return_code为FAIL时返回信息为错误原因 ,例如

签名失败

参数格式校验错误

以下字段在return_code为SUCCESS的时候有返回

字段名变量名必填类型示例值描述
公众账号IDappidString(32)wxd678efh567hg6787微信分配的公众账号ID
商户号mch_idString(32)1230000109微信支付分配的商户号
随机字符串nonce_strString(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS随机字符串,不长于32位。推荐随机数生成算法
签名signString(32)C380BEC2BFD727A4B6845133519F3AD6签名,详见签名生成算法
业务结果result_codeString(16)SUCCESSSUCCESS/FAIL
错误代码err_codeString(32)
当result_code为FAIL时返回错误代码,详细参见下文错误列表
错误代码描述err_code_desString(128)
当result_code为FAIL时返回错误描述,详细参见下文错误列表

以下字段在return_code 、result_code、trade_state都为SUCCESS时有返回 ,如trade_state不为 SUCCESS,则只返回out_trade_no(必传)和attach(选传)。

字段名变量名必填类型示例值描述
设备号device_infoString(32)013467007045764微信支付分配的终端设备号
用户标识openidString(128)oUpF8uMuAJO_M2pxb1Q9zNjWeS6o用户在商户appid下的唯一标识
是否关注公众账号is_subscribeString(1)Y用户是否关注公众账号,Y-关注,N-未关注
交易类型trade_typeString(16)JSAPI调用接口提交的交易类型,取值如下:JSAPI,NATIVE,APP,MICROPAY,详细说明见参数规定
交易状态trade_stateString(32)SUCCESS

SUCCESS—支付成功

REFUND—转入退款

NOTPAY—未支付

CLOSED—已关闭

REVOKED—已撤销(付款码支付)

USERPAYING--用户支付中(付款码支付)

PAYERROR--支付失败(其他原因,如银行返回失败)

支付状态机请见下单API页面
付款银行bank_typeString(16)CMC银行类型,采用字符串类型的银行标识
标价金额total_feeInt100订单总金额,单位为分
应结订单金额settlement_total_feeInt100当订单使用了免充值型优惠券后返回该参数,应结订单金额=订单金额-免充值优惠券金额。
标价币种fee_typeString(8)CNY货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
现金支付金额cash_feeInt100现金支付金额订单现金支付金额,详见支付金额
现金支付币种cash_fee_typeString(16)CNY货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
代金券金额coupon_feeInt100“代金券”金额<=订单金额,订单金额-“代金券”金额=现金支付金额,详见支付金额
代金券使用数量coupon_countInt1代金券使用数量
代金券类型coupon_type_$nStringCASH

CASH--充值代金券 

NO_CASH---非充值优惠券

开通免充值券功能,并且订单使用了优惠券后有返回(取值:CASH、NO_CASH)。$n为下标,从0开始编号,举例:coupon_type_$0

代金券IDcoupon_id_$nString(20)10000 代金券ID, $n为下标,从0开始编号
单个代金券支付金额coupon_fee_$nInt100单个代金券支付金额, $n为下标,从0开始编号
微信支付订单号transaction_idString(32)1009660380201506130728806387微信支付订单号
商户订单号out_trade_noString(32)20150806125346商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。
附加数据attachString(128)深圳分店附加数据,原样返回
支付完成时间time_endString(14)20141030133525订单支付时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
交易状态描述trade_state_descString(256)支付失败,请重新下单支付对当前查询订单状态的描述和下一步操作的指引

举例如下:

<xml>
                  <return_code><![CDATA[SUCCESS]]></return_code>
                  <return_msg><![CDATA[OK]]></return_msg>
                  <appid><![CDATA[wx2421b1c4370ec43b]]></appid>
                  <mch_id><![CDATA[10000100]]></mch_id>
                  <device_info><![CDATA[1000]]></device_info>
                  <nonce_str><![CDATA[TN55wO9Pba5yENl8]]></nonce_str>
                  <sign><![CDATA[BDF0099C15FF7BC6B1585FBB110AB635]]></sign>
                  <result_code><![CDATA[SUCCESS]]></result_code>
                  <openid><![CDATA[oUpF8uN95-Ptaags6E_roPHg7AG0]]></openid>
                  <is_subscribe><![CDATA[Y]]></is_subscribe>
                  <trade_type><![CDATA[MICROPAY]]></trade_type>
                  <bank_type><![CDATA[CCB_DEBIT]]></bank_type>
                  <total_fee>1</total_fee>
                  <fee_type><![CDATA[CNY]]></fee_type>
                  <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
                  <out_trade_no><![CDATA[1415757673]]></out_trade_no>
                  <attach><![CDATA[订单额外描述]]></attach>
                  <time_end><![CDATA[20141111170043]]></time_end>
                  <trade_state><![CDATA[SUCCESS]]></trade_state>
               </xml>

错误码

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


-EOF-

AI助手支持GPT4.0