微信支付 API
  1. API列表
微信支付 API
  • 文档说明
    • 阅读对象
    • 版本说明
  • 术语
    • 支付模式
    • 名词解释
  • 支付账户
    • 支付账户
  • 接口规则
    • 协议规则
    • 参数规定
    • 安全规范
    • 获取openid
  • JSAPI支付
    • 场景介绍
    • 案例介绍
    • 接入前准备
    • 开发指引
    • 获取微信版本号
    • JSAPI调起支付
    • 支付常见问题
  • API列表
    • 统一下单
      POST
    • 查询订单
      POST
    • 关闭订单
      POST
    • 申请退款
      POST
    • 查询退款
      POST
    • 下载交易账单
      POST
    • 下载资金账单
      POST
    • 支付结果通知
      POST
    • 交易保障
      POST
    • 退款结果通知
      POST
  • 最佳实践
    • 支付回调和查单实现指引
    • 支付验收指引
    • 网络排查指引
    • 最佳安全实践
    • 跨城冗灾方案
    • 回调通知注意事项
    • 专线商户Notify升级指引
    • 商户收银台H5大字号规范
    • 微信支付二维码规范
  • 运营规范
    • 运营规范
  • SDK与DEMO下载
    • SDK与DEMO下载
  1. API列表

查询订单

POST
/pay/orderquery

应用场景#

该接口提供所有微信支付订单的查询，商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。
需要调用查询接口的情况：
1.
◆ 当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知（查单实现可参考：支付回调和查单实现指引）；
2.
◆ 调用支付接口后，返回系统错误或未知交易状态情况；
3.
◆ 调用付款码支付API，返回USERPAYING的状态；
4.
◆ 调用关单或撤销接口API之前，需确认支付状态；

错误码#

名称描述原因解决方案
ORDERNOTEXIST此交易订单号不存在查询系统中不存在此交易订单号该API只能查提交支付交易返回成功的订单，请商户检查需要查询的订单号是否正确
SYSTEMERROR系统错误后台系统返回错误系统异常，请再调用发起查询
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/pay/orderquery' \
--header 'Content-Type: application/xml' \
--data-raw '<xml>
   <appid>wx2421b1c4370ec43b</appid>
   <mch_id>10000100</mch_id>
   <nonce_str>ec2316275641faa3aacf3cc599e8730f</nonce_str>
   <transaction_id>1008450740201411110005820873</transaction_id>
   <sign>FDD167FAA73459FD921B144BAF4F4CA2</sign>
</xml>'
响应示例响应示例
<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>

请求参数

Body 参数application/xml
appid
string 
公众账号ID
必需
微信支付分配的公众账号ID（企业号corpid即为此appid）
mch_id
string 
商户号
必需
微信支付分配的商户号
nonce_str
string 
随机字符串
必需
随机字符串，不长于32位。推荐随机数生成算法
transaction_id
string 
微信订单号
必需
微信的订单号，建议优先使用
sign
string 
签名
必需
通过签名算法计算得出的签名值，详见签名生成算法
out_trade_no
string 
商户订单号
必需
商户系统内部订单号，要求32个字符内（最少6个字符），只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号
sign_type
string 
签名类型
可选
签名类型，目前支持HMAC-SHA256和MD5，默认为MD5
示例

返回响应

🟢200成功
application/json
Body
return_code
string 
返回状态码
必需
SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看trade_state来判断
return_msg
string 
返回信息
必需
当return_code为FAIL时返回信息为错误原因 ，例如 签名失败 参数格式校验错误
appid
string 
公众账号ID
必需
微信分配的公众账号ID
mch_id
string 
商户号
必需
微信支付分配的商户号
device_info
string 
设备号
可选
微信支付分配的终端设备号
nonce_str
string 
随机字符串
必需
随机字符串，不长于32位。推荐随机数生成算法
sign
string 
签名
必需
签名，详见签名生成算法
result_code
string 
业务结果
必需
SUCCESS/FAIL
openid
string 
用户标识
必需
用户在商户appid下的唯一标识
is_subscribe
string 
是否关注公众账号
必需
用户是否关注公众账号，Y-关注，N-未关注
trade_type
string 
交易类型
必需
调用接口提交的交易类型，取值如下：JSAPI，NATIVE，APP，MICROPAY，详细说明见参数规定
bank_type
string 
付款银行
必需
银行类型，采用字符串类型的银行标识
total_fee
string 
标价金额
必需
订单总金额，单位为分
fee_type
string 
标价币种
可选
货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
transaction_id
string 
必需
out_trade_no
string 
必需
attach
string 
附加数据
必需
附加数据，原样返回
time_end
string 
支付完成时间
必需
订单支付时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
trade_state
string 
交易状态
必需
SUCCESS--支付成功 REFUND--转入退款 NOTPAY--未支付 CLOSED--已关闭 REVOKED--已撤销(刷卡支付) USERPAYING--用户支付中 PAYERROR--支付失败(其他原因，如银行返回失败) ACCEPT--已接收，等待扣款 支付状态机请见下单API页面
err_code
string 
错误代码
可选
当result_code为FAIL时返回错误代码，详细参见下文错误列表
err_code_des 
string 
错误代码描述
可选
当result_code为FAIL时返回错误描述，详细参见下文错误列表
cash_fee
string 
现金支付金额
必需
现金支付金额订单现金支付金额，详见支付金额
cash_fee_type 
string 
现金支付币种
可选
货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
coupon_fee
string 
代金券金额
可选

“代金券”金额<=订单金额，订单金额-“代金券”金额=现金支付金额，详见支付金额

coupon_count 
string 
代金券使用数量
可选
代金券使用数量
coupon_type_$n 
string 
代金券类型
可选
CASH：充值代金券 NO_CASH：非充值优惠券 开通免充值券功能，并且订单使用了优惠券后有返回（取值：CASH、NO_CASH）。0
coupon_id_$n 
string 
代金券ID
可选
代金券ID, $n为下标，从0开始编号
coupon_fee_$n 
string 
单个代金券支付金额
可选
单个代金券支付金额, $n为下标，从0开始编号
transaction_id 
string 
微信支付订单号
必需
微信支付订单号
out_trade_no 
string 
商户订单号
必需
商户系统内部订单号，要求32个字符内（最少6个字符），只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号
trade_state_desc
string 
交易状态描述
必需
对当前查询订单状态的描述和下一步操作的指引
settlement_total_fee 
string 
应结订单金额
可选
当订单使用了免充值型优惠券后返回该参数，应结订单金额=订单金额-免充值优惠券金额。
修改于 2022-07-22 12:10:51
上一页
统一下单
下一页
关闭订单
Built with