微信支付API
产品介绍
开发指引
API列表
JSAPI/小程序下单
POST
JSAPI调起支付
微信支付订单号查询订单
GET
商户订单号查询订单
GET
关闭订单
POST
支付成功回调通知
退款申请
POST
查询单笔退款（通过商户退款单号）
GET
发起异常退款
POST
常见问题
附录
管理商户号绑定的APPID账号
配置JSAPI支付授权目录
Powered by Hapydev
JSAPI/小程序下单已发布
POSThttps://api.mch.weixin.qq.com/v3/pay/transactions/jsapi
创建时间: 2025-05-31 22:46
请求参数
Header 参数
参数名示例值是否必填参数类型描述说明
AuthorizationWECHATPAY2-SHA256-RSA2048 mchid="1900000001",...是string请参考签名认证生成认证信息
Acceptapplication/json是string请设置为application/json
Content-Typeapplication/json是string请设置为application/json
Body 参数application/json
数据结构
appidstring
必填
【公众账号ID】是商户在微信开放平台（移动应用）或公众平台（公众号/小程序）上申请的一个唯一标识。需确保该appid与mchid有绑定关系，具体请参考普通商户模式开发必要参数说明。
mchidstring
必填
【商户号】是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式请参考普通商户模式开发必要参数说明。
descriptionstring
必填
【商品描述】商品信息描述，用户微信账单的商品字段中可见(可参考JSAPI支付示例说明-账单示意图)，商户需传递能真实代表商品信息的描述，不能超过127个字符。
out_trade_nostring
必填
【商户订单号】商户系统内部订单号，要求6-32个字符内，只能是数字、大小写字母_-|* 且在同一个商户号下唯一。
time_expirestring
可选
【支付结束时间】 1、定义：支付结束时间是指用户能够完成该笔订单支付的最后时限，并非订单关闭的时间。超过此时间后，用户将无法对该笔订单进行支付。如需关闭订单，请调用关闭订单API接口。 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秒。 3、注意事项： time_expire 参数仅在用户首次下单时可设置，且不允许后续修改，尝试修改将导致错误。 若用户实际进行支付的时间超过了订单设置的支付结束时间，商户需使用新的商户订单号下单，生成新的订单供用户进行支付。若未超过支付结束时间，则可使用原参数重新请求下单接口，以获取当前订单最新的prepay_id 进行支付。 支付结束时间不能早于下单时间后1分钟，若设置的支付结束时间早于该时间，系统将自动调整为下单时间后1分钟作为支付结束时间。
attachstring
可选
【商户数据包】商户在创建订单时可传入自定义数据包，该数据对用户不可见，用于存储订单相关的商户自定义信息，其总长度限制在128字符以内。支付成功后查询订单API和支付成功回调通知均会将此字段返回给商户，并且该字段还会体现在交易账单。
notify_urlstring
必填
【商户回调地址】商户接收支付成功回调通知的地址，需按照notify_url填写注意事项规范填写。
goods_tagstring
可选
【订单优惠标记】代金券在创建时可以配置多个订单优惠标记，标记的内容由创券商户自定义设置。详细参考：创建代金券批次API。如果代金券有配置订单优惠标记，则必须在该参数传任意一个配置的订单优惠标记才能使用券。如果代金券没有配置订单优惠标记，则可以不传该参数。 示例：如有两个活动，活动A设置了两个优惠标记：WXG1、WXG2；活动B设置了两个优惠标记：WXG1、WXG3；下单时优惠标记传WXG2，则订单参与活动A的优惠；下单时优惠标记传WXG3，则订单参与活动B的优惠；下单时优惠标记传共同的WXG1，则订单参与活动A、B两个活动的优惠；
support_fapiaoboolean
可选
【电子发票入口开放标识】 传入true时，支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能，传此字段才可生效。 详细参考：电子发票介绍 true：是 false：否
amountobject
必填
【订单金额】订单金额信息
totalinteger
可选
【总金额】 订单总金额，单位为分，整型。 示例：1元应填写 100
currencystring
可选
【货币类型】符合ISO 4217标准的三位字母代码，固定传：CNY，代表人民币。
payerobject
必填
【支付者信息】支付者信息
openidstring
必填
【用户标识】用户在商户appid下的唯一标识。下单前需获取到用户的OpenID，详见OpenID获取。
detailobject
可选
【优惠功能】 优惠功能
cost_priceinteger
可选
【订单原价】 1、商户侧一张小票订单可能被分多次支付，订单原价用于记录整张小票的交易金额。 2、当订单原价与支付金额不相等，则不享受优惠。 3、该字段主要用于防止同一张小票分多次支付，以享受多次优惠的情况，正常支付订单不必上传此参数。
invoice_idstring
可选
【商品小票ID】 商家小票ID
goods_detailarray<object>
可选
【单品列表】 单品列表信息
merchant_goods_idstring
必填
【商户侧商品编码】 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。
wechatpay_goods_idstring
可选
【微信支付商品编码】 微信支付定义的统一商品编号（没有可不传）
goods_namestring
可选
【商品名称】 商品的实际名称
quantityinteger
必填
【商品数量】 用户购买的数量
unit_priceinteger
必填
【商品单价】整型，单位为：分。如果商户有优惠，需传输商户优惠后的单价(例如：用户对一笔100元的订单使用了商场发的纸质优惠券100-50，则活动商品的单价应为原单价-50)
scene_infoobject
可选
【场景信息】 场景信息
payer_client_ipstring
可选
【用户终端IP】 用户的客户端IP，支持IPv4和IPv6两种格式的IP地址。
device_idstring
可选
【商户端设备号】 商户端设备号（门店号或收银设备ID）。
store_infoobject
可选
【商户门店信息】 商户门店信息
idstring
必填
【门店编号】商户侧门店编号，总长度不超过32字符，由商户自定义。
namestring
可选
【门店名称】 商户侧门店名称，由商户自定义。
area_codestring
可选
【地区编码】 地区编码，详细请见省市区编号对照表。
addressstring
可选
【详细地址】 详细的商户门店地址，由商户自定义。
settle_infoobject
可选
【结算信息】 结算信息
profit_sharingboolean
可选
【分账标识】订单的分账标识在下单时设置，传入true表示在订单支付成功后可进行分账操作。以下是详细说明： 需要分账（传入true）： 订单收款成功后，资金将被冻结并转入基本账户的不可用余额。商户可通过请求分账API，将收款资金分配给其他商户或用户。完成分账操作后，可通过接口解冻剩余资金，或在支付成功30天后自动解冻。 不需要分账（传入false或不传，默认为false）： 订单收款成功后，资金不会被冻结，而是直接转入基本账户的可用余额。
示例数据
{
  "appid": "wxd678efh567hg6787",
  "mchid": "1230000109",
  "description": "Image形象店-深圳腾大-QQ公仔",
  "out_trade_no": "1217752501201407033233368018",
  "time_expire": "2018-06-08T10:34:56+08:00",
  "attach": "自定义数据说明",
  "notify_url": " https://www.weixin.qq.com/wxpay/pay.php",
  "goods_tag": "WXG",
  "support_fapiao": false,
  "amount": { "total": 100, "currency": "CNY" },
  "payer": {
    "openid": "ovqdowRIfstpQK_kYShFS2MSS9XS"
  },
  "detail": {
    "cost_price": 608800,
    "invoice_id": "微信123",
    "goods_detail": [
      {
        "merchant_goods_id": "1246464644",
        "wechatpay_goods_id": "1001",
        "goods_name": "iPhoneX 256G",
        "quantity": 1,
        "unit_price": 528800
      }
    ]
  },
  "scene_info": {
    "payer_client_ip": "14.23.150.211",
    "device_id": "013467007045764",
    "store_info": {
      "id": "0001",
      "name": "腾讯大厦分店",
      "area_code": "440305",
      "address": "广东省深圳市南山区科技中一道10000号"
    }
  },
  "settle_info": { "profit_sharing": false }
}
响应示例
成功
HTTP状态码：200
内容格式：JSON
数据结构
prepay_idstring
可选
【预支付交易会话标识】预支付交易会话标识，JSAPI或小程序调起支付时需要使用的参数，有效期为2小时，失效后需要重新请求该接口以获取新的prepay_id。
响应示例
{
  "prepay_id": "wx201410272009395522657a690389285100"
}
最后更新: 2 个月前
上一页
开发指引
下一页
JSAPI调起支付