微信支付 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
https://api.mch.weixin.qq.com/payitil/report

应用场景#

商户在调用微信支付提供的相关接口时,会得到微信支付返回的相关信息以及获得整个接口的响应时间。为提高整体的服务水平,协助商户一起提高服务质量,微信支付提供了相关接口调用耗时和返回信息的主动上报接口,微信支付可以根据商户侧上报的数据进一步优化网络部署,完善服务监控,和商户更好的协作为用户提供更好的业务体验。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.mch.weixin.qq.com/payitil/report' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<root>
  <appid>string</appid>
  <mch_id>string</mch_id>
  <device_info>string</device_info>
  <nonce_str>string</nonce_str>
  <sign>string</sign>
  <sign_type>string</sign_type>
  <interface_url>string</interface_url>
  <execute_time_>string</execute_time_>
  <return_code>string</return_code>
  <return_msg>string</return_msg>
  <result_code>string</result_code>
  <err_code>string</err_code>
  <err_code_des>string</err_code_des>
  <out_trade_no>string</out_trade_no>
  <user_ip>string</user_ip>
  <time>string</time>
</root>'
响应示例响应示例
{
  "return_code": "string",
  "return_msg": "string",
  "result_code": "string"
}

请求参数

Body 参数application/xml
appid
string 
公众账号ID
必需
微信分配的公众账号ID(企业号corpid即为此appid)
mch_id
string 
商户号
必需
微信支付分配的商户号
device_info
string 
设备号
可选
微信支付分配的终端设备号,商户自定义
nonce_str
string 
随机字符串
必需
随机字符串,不长于32位。推荐随机数生成算法
sign
string 
签名
必需
签名,详见签名生成算法
sign_type
string 
签名类型
必需
签名类型,目前支持HMAC-SHA256和MD5,默认为MD5
interface_url
string 
接口URL
必需
报对应的接口的完整URL,类似: https://api.mch.weixin.qq.com/pay/unifiedorder 对于刷卡支付,为更好的和商户共同分析一次业务行为的整体耗时情况,对于两种接入模式,请都在门店侧对一次刷卡支付进行一次单独的整体上报,上报URL指定为: https://api.mch.weixin.qq.com/pay/micropay/total 关于两种接入模式具体可参考本文档章节:刷卡支付商户接入模式 其它接口调用仍然按照调用一次,上报一次来进行。
execute_time_
string 
接口耗时
必需
接口耗时情况,单位为毫秒 注意:该参数最后带有下划线“_”,参数设计如此,非文档问题。
return_code
string 
返回状态码
必需
SUCCESS/FAIL 此字段是通信标识,非交易标识,交易是否成功需要查看trade_state来判断
return_msg
string 
返回信息
必需
当return_code为FAIL时返回信息为错误原因 ,例如 签名失败 参数格式校验错误
result_code
string 
业务结果
必需
SUCCESS/FAIL
err_code
string 
错误代码
可选
ORDERNOTEXIST—订单不存在 SYSTEMERROR—系统错误
err_code_des
string 
错误代码描述
可选
结果信息描述
out_trade_no
string 
商户订单号
可选
商户系统内部的订单号,商户可以在上报时提供相关商户订单号方便微信支付更好的提高服务质量。
user_ip
string 
访问接口IP
必需
发起接口调用时的机器IP
time
string 
商户上报时间
可选
系统时间,格式为yyyyMMddHHmmss,如2009年12月27日9点10分10秒表示为20091227091010。其他详见时间规则
示例

返回响应

🟢200成功
application/json
Body
return_code
string 
返回状态码
必需
SUCCESS/FAIL 此字段是通信标识,非交易标识,交易是否成功需要查看result_code来判断
return_msg
string 
返回信息
可选
返回信息,如非空,为错误原因 签名失败 参数格式校验错误
result_code
string 
业务结果
必需
SUCCESS/FAIL。此字段在return_code为SUCCESS的时候有返回
上一页
支付结果通知
下一页
退款结果通知
Built with