通过商户订单号查询订单

更新时间:2024.10.31
||

前置条件

支付成功后获得商户订单号(out_trade_no

接口功能

通过商户订单号查询订单

接口说明

支持商户:【普通商户】

请求方式:【GET】/v3/edu-papay/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)

【商户订单号】商户订单号

请求示例

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/edu-papay/transactions/out-trade-no/201407033233368018 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数
折叠全部参数

200 OK

 sp_mchid  必填   string(32)

【服务商商户号】微信支付分配的商户号


 appid  必填   string(32)

【服务商APPID】微信公众平台为商户的应用分配的ID,与服务商商户号存在绑定关系


 out_trade_no  必填   string(32)

【商户订单号】商户订单号


 transaction_id  选填   string(32)

【微信支付订单号】微信支付订单号


 attach  选填   string(127)

【商户数据】附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据


 bank_type  选填   string(16)

【付款银行】银行类型,采用字符串类型的银行标识,值列表详见银行类型


 success_time  选填   string(32)

【支付完成时间】支付成功时返回,按照使用rfc3339所定义的格式,格式为YYYY-MM-DDThh:mm:ss+TIMEZONE


 trade_state  必填   string(32)

【交易状态】枚举值:SUCCESS—支付成功,REFUND—转入退款,ACCEPTED—已受理,未支付,PAY_FAIL--支付失败(其他原因,如银行返回失败)


 trade_state_description  选填   string(256)

【交易状态描述】对当前订单状态的描述和下一步操作的指引


 payer  选填   object

【支付者】支付者

属性

 openid  选填   string(128)

【服务商APPID下的用户标识】用户在服务商appid下的唯一标识


 amount  必填   object

【订单金额】订单金额信息

属性

 total  必填   integer

【订单金额】订单总金额,单位为分,只能为整数


 payer_total  选填   integer

【用户支付金额】用户实际支付金额,单位为分,只能为整数


 discount_total  选填   integer

【折扣】订单折扣


 currency  选填   string(16)

【货币类型】符合ISO 4217标准的三位字母代码,目前只支持人民币:CNY


 device_information  必填   object

【设备信息】设备信息

属性

 device_id  选填   string(32)

【设备号】商户设备号


 device_ip  必填   string(46)

【商户端设备ip】商户端设备IP(发起扣款请求的商户服务器ip)


 promotion_detail  选填   array[object]

【优惠详情】优惠详情

属性

 coupon_id  选填   string(32)

【券ID】券ID


 name  选填   string(64)

【优惠名称】优惠名称


 scope  选填   string(32)

【优惠范围】GLOBAL:全场代金券;SINGLE:单品优惠


 type  选填   string(32)

【优惠类型】COUPON-代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致),DISCOUNT-优惠券,不走结算资金的免充值型优惠券,(境外商户券币种与标价币种一致)


 amount  选填   integer

【优惠券面额】优惠券面额


 stock_id  选填   string(32)

【活动ID】活动ID,批次ID


 wechatpay_contribute  选填   integer

【微信出资】特指由微信支付商户平台创建的优惠,出资金额等于本项优惠总金额,单位为分


 merchant_contribute  选填   integer

【商户出资】特指商户自己创建的优惠,出资金额等于本项优惠总金额,单位为分


 other_contribute  选填   integer

【其他出资】其他出资方出资金额,单位为分

应答示例

200 OK

1{
2  "sp_mchid" : "1230000109",
3  "appid" : "wx8888888888888888",
4  "out_trade_no" : "201407033233368018",
5  "transaction_id" : "25012014070332333018",
6  "attach" : "自定义数据",
7  "bank_type" : "CMC",
8  "success_time" : "2020-03-26T10:43:39+08:00",
9  "trade_state" : "SUCCESS",
10  "trade_state_description" : "支付成功",
11  "payer" : {
12    "openid" : "oUpF8uMuAJOM2pxb1Q"
13  },
14  "amount" : {
15    "total" : 888,
16    "payer_total" : 888,
17    "discount_total" : 100,
18    "currency" : "CNY"
19  },
20  "device_information" : {
21    "device_id" : "12343232",
22    "device_ip" : "123.12.12.123"
23  },
24  "promotion_detail" : [
25    {
26      "coupon_id" : "109519",
27      "name" : "单品惠-6",
28      "scope" : "GLOBAL",
29      "type" : "DISCOUNT",
30      "amount" : 5,
31      "stock_id" : "931386",
32      "wechatpay_contribute" : 0,
33      "merchant_contribute" : 0,
34      "other_contribute" : 0
35    }
36  ]
37}
38

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

500

SYSTEM_ERROR

系统错误

系统异常,请使用相同参数稍后重新调用

403

NO_AUTH

商户无权限

请开通商户号权限。请联系产品或商务申请

403

NOT_ENOUGH

余额不足

用户账号余额不足,请用户充值或更换支付卡后再支付

429

RATELIMIT_EXCEEDED

频率限制

请降低频率后重试

400

INVALID_REQUEST

请求的业务参数符合参数格式,但不符合业务规则

请使用正确的参数重新调用

401

SIGN_ERROR

签名错误

请检查签名参数和方法是否都符合签名算法要求

400

ALREADY_EXISTS

资源已存在

尝试创建的资源已存在,无需重复创建

404

NOT_FOUND

请求的资源不存在

请商户检查需要查询的ID或者请求URL是否正确

 

 

反馈
目录
置顶