微信支付API
产品介绍
开发指引
API列表
JSAPI/小程序下单
POST
JSAPI调起支付
微信支付订单号查询订单
GET
商户订单号查询订单
GET
关闭订单
POST
支付成功回调通知
退款申请
POST
查询单笔退款(通过商户退款单号)
GET
发起异常退款
POST
常见问题
附录
管理商户号绑定的APPID账号
配置JSAPI支付授权目录
商户订单号查询订单开发中
GEThttps://api.mch.weixin.qq.com/v3/pay/transactions/out-trade-no/:out_trade_no?mchid=1900000001
创建时间: 2025-05-31 23:09
请求参数
路径参数
参数名 | 示例值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
out_trade_no | <string> | - | - | 【商户订单号】 商户下单时传入的商户系统内部订单号。 |
Header 参数
参数名 | 示例值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
Authorization | WECHATPAY2-SHA256-RSA2048 mchid="1900000001",... | 是 | string | 请参考签名认证生成认证信息 |
Accept | application/json | 是 | string | 请设置为application/json |
Query 参数
参数名 | 示例值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
mchid | 1900000001 | 是 | string | 【商户号】商户下单时传入的商户号。 |
响应示例
成功
HTTP状态码:200
内容格式:JSON
数据结构
appidstring
必填
【公众账号ID】商户下单时传入的公众账号ID。
mchidstring
必填
【商户号】商户下单时传入的商户号。
out_trade_nostring
必填
【商户订单号】商户下单时传入的商户系统内部订单号。
transaction_idstring
必填
【微信支付订单号】 微信支付侧订单的唯一标识。
trade_typestring
必填
【交易类型】 返回当前订单的交易类型,枚举值: JSAPI:公众号支付、小程序支付 NATIVE:Native支付 APP:APP支付 MICROPAY:付款码支付 MWEB:H5支付 FACEPAY:刷脸支付
trade_statestring
必填
【交易状态】 返回订单当前交易状态。详细业务流转状态处理请参考开发指引-订单状态流转图。枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 REVOKED:已撤销(仅付款码支付会返回) USERPAYING:用户支付中(仅付款码支付会返回) PAYERROR:支付失败(仅付款码支付会返回)
trade_state_descstring
可选
【交易状态描述】 对交易状态的详细说明。
bank_typestring
可选
【银行类型】 用户支付方式说明,订单支付成功后返回,格式为银行简码_具体类型(DEBIT借记卡/CREDIT信用卡/ECNY数字人民币),例如ICBC_DEBIT代表工商银行借记卡,非银行卡支付类型(例如余额/零钱通等)统一为OTHERS,具体请参考《银行类型对照表》。
attachstring
可选
【商户数据包】商户下单时传入的自定义数据包,用户不可见,长度不超过128字符,若下单传入该参数,则订单支付成功后此接口和支付成功回调通知以及交易账单中会原样返回;若下单未传该参数,则不会返回。
success_timestring
可选
【支付完成时间】 1、定义:用户完成订单支付的时间。该参数在订单支付成功后返回。 2、格式:遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。 示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。
amountobject
必填
【订单金额】订单金额信息
totalinteger
可选
【总金额】 订单总金额,单位为分,整型。 示例:1元应填写 100
currencystring
可选
【货币类型】符合ISO 4217标准的三位字母代码,固定传:CNY,代表人民币。
payerobject
必填
【支付者信息】支付者信息
openidstring
必填
【用户标识】用户在商户appid下的唯一标识。下单前需获取到用户的OpenID,详见OpenID获取。
scene_infoobject
可选
【场景信息】 场景信息
payer_client_ipstring
可选
【用户终端IP】 用户的客户端IP,支持IPv4和IPv6两种格式的IP地址。
device_idstring
可选
【商户端设备号】 商户端设备号(门店号或收银设备ID)。
settle_infoobject
可选
【结算信息】 结算信息
profit_sharingboolean
可选
【分账标识】订单的分账标识在下单时设置,传入true表示在订单支付成功后可进行分账操作。以下是详细说明: 需要分账(传入true): 订单收款成功后,资金将被冻结并转入基本账户的不可用余额。商户可通过请求分账API,将收款资金分配给其他商户或用户。完成分账操作后,可通过接口解冻剩余资金,或在支付成功30天后自动解冻。 不需要分账(传入false或不传,默认为false): 订单收款成功后,资金不会被冻结,而是直接转入基本账户的可用余额。
promotion_detailarray<object>
必填
【优惠功能】 代金券信息,当订单有使用代金券时,该字段将返回所使用的代金券信息。
coupon_idstring
可选
【券ID】 代金券id,微信为代金券分配的唯一标识,创券商户调用发放指定批次的代金券时返回的代金券ID coupon_id。
namestring
必填
【优惠名称】 优惠名称,创券商户创建代金券批次时传入的批次名称stock_name。
scopestring
可选
【优惠范围】优惠活动中代金券的适用范围,分为两种类型: 1、GLOBAL:全场代金券-以订单整体可优惠的金额为优惠门槛的代金券; 2、SINGLE:单品优惠-以订单中具体某个单品的总金额为优惠门槛的代金券
typestring
可选
【优惠类型】代金券资金类型,优惠活动中代金券的结算资金类型,分为两种类型: 1、CASH:预充值-带有结算资金的代金券,会随订单结算给订单收款商户; 2、NOCASH:免充值-不带有结算资金的代金券,无资金结算给订单收款商户。
amountinteger
必填
【优惠券面额】代金券优惠的金额。
stock_idstring
可选
【活动ID】单张代金券所对应的批次号
wechatpay_contributeinteger
可选
【微信出资】 代金券有三种出资类型:微信出资、商户出资和其他出资。本参数将返回选择“微信出资类型”时的优惠券面额。 1、创建代金券后默认为商户出资类型。如需使用其他两种类型,请与相关行业运营进行沟通。 2、在 wechatpay_contribute、merchant_contribute 和 other_contribute 这三个字段中,仅有一个字段会返回出资金额。具体返回哪个字段取决于代金券批次的配置。
merchant_contributeinteger
可选
【商户出资】代金券有三种出资类型:微信出资、商户出资和其他出资。本参数将返回选择“商户出资类型”时的优惠券面额。 1、创建代金券后默认为商户出资类型。如需使用其他两种类型,请与相关行业运营进行沟通。 2、在 wechatpay_contribute、merchant_contribute 和 other_contribute 这三个字段中,仅有一个字段会返回出资金额。具体返回哪个字段取决于代金券批次的配置。
other_contributeinteger
可选
【其他出资】代金券有三种出资类型:微信出资、商户出资和其他出资。本参数将返回选择“其他出资类型”时的优惠券面额。 1、创建代金券后默认为商户出资类型。如需使用其他两种类型,请与相关行业运营进行沟通。 2、在 wechatpay_contribute、merchant_contribute 和 other_contribute 这三个字段中,仅有一个字段会返回出资金额。具体返回哪个字段取决于代金券批次的配置。
currencystring
可选
【优惠币种】 代金券金额所对应的货币种类:固定为:CNY,人民币。
goods_detailarray<object>
可选
【单品列表】 单品列表。scope为SINGLE(单品优惠)时返回该参数
goods_idinteger
可选
【商品编码】 商品编码。
quantityinteger
必填
【商品数量】 商品数量。
unit_priceinteger
必填
【商品单价】 商品单价,单位为分。
discount_amountinteger
必填
【商品优惠金额】 商品优惠金额。
goods_remarkstring
可选
【商品备注】 商品备注。创券商户在商户平台创建单品券时,若设置了商品备注则会返回。
响应示例
{
"appid": "wxd678efh567hg6787",
"mchid": "1230000109",
"out_trade_no": "1217752501201407033233368018",
"transaction_id": "1217752501201407033233368018",
"trade_type": "APP",
"trade_state": "SUCCESS",
"trade_state_desc": "支付成功",
"bank_type": "CMC",
"attach": "自定义数据",
"success_time": "2018-06-08T10:34:56+08:00",
"payer": {
"openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o\t"
},
"amount": {
"total": 100,
"payer_total": 90,
"currency": "CNY",
"payer_currency": "CNY"
},
"scene_info": { "device_id": "013467007045764" },
"promotion_detail": [
{
"coupon_id": "109519",
"name": "单品惠-6",
"scope": "SINGLE",
"type": "CASH",
"amount": 10,
"stock_id": "931386",
"wechatpay_contribute": 0,
"merchant_contribute": 10,
"other_contribute": 0,
"currency": "CNY",
"goods_detail": [
{
"goods_id": "M1006",
"quantity": 1,
"unit_price": 100,
"discount_amount": 10,
"goods_remark": "商品备注信息"
}
]
}
]
}
最后更新: 2 个月前