查询订单
更新时间:2025.04.07该接口仅提供微信扣款服务申请扣款接口创建的订单进行查询,商户可以通过该接口主动查询微信代扣订单状态,完成下一步的业务逻辑。
|
接口说明
适用对象:直连商户
请求URL: https://api.mch.weixin.qq.com/pay/paporderquery
请求方式: POST
数据格式: XML
是否需要证书: 否
请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
应用ID | appid | string[1,32] | 是 | 直连商户申请的公众号或移动应用appid。 |
商户号 | mch_id | string[1,32] | 是 | 微信支付分配的商户号 |
微信订单号 | transaction_id | string[1,32] | 二选一 | 微信生成的订单号,在支付通知中有返回 |
商户订单号 | out_trade_no | string[1,32] | 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 | |
随机字符串 | nonce_str | string[1,32] | 是 | 随机字符串,不长于32位。推荐随机数生成算法 |
签名 | sign | string[1,32] | 是 | 签名,详见签名生成算法 |
请求示例:
返回参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | return_code | string[1,16] | 是 | SUCCESS/FAIL |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,为错误原因 |
以下字段在return_code为SUCCESS的时候有返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
应用ID | appid | string[1,32] | 是 | 直连商户申请的公众号或移动应用appid。 |
商户号 | mch_id | string[1,32] | 是 | 微信支付分配的商户号 |
随机字符串 | nonce_str | string[1,32] | 是 | 随机字符串,不长于32位 |
签名 | sign | string[1,32] | 是 | 签名,详见签名算法 |
业务结果 | result_code | string[1,16] | 是 | SUCCESS/FAIL |
错误代码 | err_code | string[1,32] | 否 | 列表详见错误码列表 |
错误代码描述 | err_code_des | string[1,128] | 否 | 结果信息描述 |
以下字段在return_code 和result_code都为SUCCESS的时候有返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
设备号 | device_info | string[1,32] | 否 | 微信支付分配的终端设备号, |
用户标识 | openid | string[1,128] | 否 | 用户在商户appid下的唯一标识 |
是否关注公众账号 | is_subscribe | string[1,1] | 否 | 用户是否关注公众账号,枚举值: |
交易类型 | trade_type | string[1,16] | 是 | 调用接口提交的交易类型,取值如下:JSAPI,NATIVE,APP,MICROPAY,详细说明见参数规定 |
交易状态 | trade_state | string[1,32] | 是 | SUCCESS:支付成功 |
付款银行 | bank_type | string[1,32] | 是 | 银行类型,采用字符串类型的银行标识 |
总金额 | total_fee | int | 是 | 订单总金额,单位为分 |
货币种类 | fee_type | string[1,8] | 否 | 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
现金支付金额 | cash_fee | int | 是 | 现金支付金额订单现金支付金额,详见支付金额 |
现金支付货币类型 | cash_fee_type | string[1,16] | 否 | 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
代金券或立减优惠金额 | coupon_fee | int | 否 | “代金券或立减优惠”金额<=订单总金额,订单总金额-“代金券或立减优惠”金额=现金支付金额,详见支付金额 |
代金券或立减优惠使用数量 | coupon_count | int | 否 | 代金券或立减优惠使用数量 |
代金券或立减优惠ID | coupon_id_$n | string[1,20] | 否 | 代金券或立减优惠ID, $n为下标,从0开始编号 |
单个代金券或立减优惠支付金额 | coupon_fee_$n | int | 否 | 单个代金券或立减优惠支付金额, $n为下标,从0开始编号 |
微信支付订单号 | transaction_id | string[1,32] | 是 | 微信支付订单号 |
商户订单号 | out_trade_no | string[1,32] | 是 | 商户系统的订单号,与请求一致。 |
附加数据 | attach | string[1,128] | 否 | 附加数据,原样返回 |
支付完成时间 | time_end | string[1,14] | 是 | 订单支付时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则 |
交易状态描述 | trade_state_desc | string[1,256] | 否 | 对当前查询订单状态的描述和下一步操作的指引 |
返回示例:
错误码
名称 | 描述 | 解决方案 |
---|---|---|
ORDERNOTEXIST | 此交易订单号不存在 | 该API只能查提交支付交易返回成功的订单,请商户检查需要查询的订单号是否正确 |
SYSTEMERROR | 系统错误 | 系统异常,请再调用发起查询 |