开发指引
更新时间：2023.08.23# 1. 接口规则
为了在保证支付安全的前提下，带给商户简单、一致且易用的开发体验，我们推出了全新的微信支付APIv3接口。该版本API的具体规则请参考APIv3接口规则。
# 2. 开发准备
# 2.1. 搭建和配置开发环境
为了帮助开发者调用开放接口，我们提供了JAVA、PHP、GO三种语言版本的开发库，封装了签名生成、签名验证、敏感信息加/解密、媒体文件上传 等基础功能（更多语言版本的开发库将在近期陆续提供）。
测试步骤：
1、根据自身开发语言，选择对应的开发库并构建项目，具体配置请参考下面链接的详细说明：
- wechatpay-java (opens new window)（推荐）、wechatpay-apache-httpclient (opens new window)，适用于Java开发者。
- 注：当前开发指引接口JAVA示例代码采用wechatpay-apache-httpclient版本。
- wechatpay-php (opens new window)（推荐）、wechatpay-guzzle-middleware (opens new window)，适用于PHP开发者。
- 注：当前开发指引接口PHP示例代码采用wechatpay-guzzle-middleware版本。
- wechatpay-go (opens new window)，适用于Go开发者。
更多资源可前往微信支付开发者社区 (opens new window)搜索查看。
2、创建加载商户私钥、加载平台证书、初始化httpClient的通用方法。
3、基于接口的示例代码，替换请求参数后可发起测试。
说明：
- 上面的开发库为微信支付官方开发库，其它没有审核或者控制下的第三方工具和库，微信支付不保证它们的安全性和可靠性。通过包管理工具引入SDK后，可根据下面每个接口的示例代码替换相关参数后进行快速测试。
- 开发者如果想详细了解签名生成、签名验证、敏感信息加/解密、媒体文件上传等常用方法的具体代码实现，可阅读下面的详细说明：
- 如想更详细的了解我们的接口规则，可查看我们的接口规则指引文档。
# 2.2. 业务开发配置
# 2.2.1.账号申请指引
- 小程序开通微信支付，即申请或复用微信支付商户号，申请完小程序后，登录小程序后台 (opens new window)。点击左侧导航栏的微信支付，在页面中进行开通。（开通申请要求小程序已发布上线）
- 点击开通按钮后，有2种方式可以获取微信支付能力，新申请微信支付商户号或绑定一个已有的微信支付商户号，请根据你的业务需要和具体情况选择，只能二选一。详见开通指引 (opens new window)。
# 2.2.2.服务器配置要求
- 小程序访问商户服务都是通过HTTPS,开发部署的时候需要HTTPS服务器。
- 服务器域名配置。
- 每个微信小程序需要事先设置通信域名，小程序只可以跟指定的域名进行网络通信。包括普通 HTTPS 请求(wx.request)、上传文件(wx.uploadFile)、下载文件(wx.downloadFile)和
WebSocket通信(wx.connectSocket)。 - 从基础库 2.4.0 开始，网络接口允许与局域网 IP 通信，但要注意 不允许与本机 IP 通信。
注意
- 域名只支持 HTTPS (wx.request、wx.uploadFile、wx.downloadFile)和 wss(wx.connectSocket)协议。
- 域名不能使用 IP 地址（小程序的局域网 IP 除外）或
localhost。 - 可以配置端口，如
https://myserver.com:8080，但是配置后只能向https://myserver.com:8080/发起请求。如果向https://myserver.com、https://myserver.com:9091等 URL 请求则会失败。 - 如果不配置端口。如
https://myserver.com，那么请求的 URL 中也不能包含端口，甚至是默认的 443 端口也不可以。如果向https://myserver.com:443请求则会失败。 - 域名必须经过 ICP 备案。
- 出于安全考虑，
API.weixin.qq.com不能被配置为服务器域名，相关API也不能在小程序内调用。 开发者应将AppSecret保存到后台服务器中，通过服务器使用 getAccessToken (opens new window) 接口获取access_token，并调用相关 API。 - 不支持配置父域名，使用子域名。
- 可查阅小程序网络请求 (opens new window)以了解更多信息。
# 3. 快速接入
# 3.1. 业务流程图
重点步骤说明：
步骤4： 用户下单发起支付，商户可通过JSAPI下单创建支付订单。
步骤9： 商户小程序内使用小程序调起支付API（wx.requestPayment）发起微信支付，详见小程序API文档 (opens new window)。
步骤16： 用户支付成功后，商户可接收到微信支付支付结果通知支付通知API。
步骤21： 商户在没有接收到微信支付结果通知的情况下需要主动调用查询订单API查询支付结果。
# 3.2. API接入（含示例代码）
本章节展示了如何使用微信支付服务端 SDK 快速接入小程序支付产品，完成与微信支付对接的部分。
注意
- 文档中的代码示例是用来阐述 API 基本使用方法，代码中的示例参数需替换成商户自己账号及请求参数才能跑通。
- 以下接入步骤仅提供参考，请商户结合自身业务需求进行评估、修改。
# 3.2.1. 【服务端】小程序下单
步骤说明： 用户通过商户小程序进入商户网页，当用户选择相关商品购买时，商户系统先调用该接口在微信支付服务后台生成预支付交易单。
重要入参说明：
- out_trade_no： 商户系统内部订单号，只能是数字、大小写字母_-*且在同一个商户号下唯一。
- description： 商品描述。
- notify_url： 支付回调通知URL，该地址必须为直接可访问的URL，不允许携带查询串。
- total： 订单总金额，单位为分。
- OpenID： OpenID是微信用户在AppID下的唯一用户标识（AppID不同，则获取到的OpenID就不同），可用于永久标记一个用户。OpenID获取方式请参考以下文档小程序获取OpenID (opens new window)、公众号获取OpenID (opens new window)、App获取OpenID (opens new window)。
更多参数、响应详情及错误码请参见JSAPI下单接口文档。
# 3.2.2. 【客户端】小程序调起支付API
步骤说明： 通过JSAPI下单成功获取预支付交易会话标识（prepay_id） 后，需要通过小程序调起支付API来调起微信支付收银台。
注意
- 此API需要将请求参数进行签名（参与签名的参数为：AppID、timeStamp、nonceStr、package，参数区分大小写）。
- AppID必须为最后拉起收银台的小程序AppID。
重要入参说明：
- package： 小程序下单接口返回的prepay_id参数值，提交格式如：prepay_id=***。
- signType： 该接口V3版本仅支持RSA。
- paySign： 签名。
paySign生成规则、响应详情请参见小程序调起支付API接口文档。
# 3.2.3. 【服务端】接收支付结果通知
步骤说明： 当用户完成支付，微信会把相关支付结果将通过异步回调的方式通知商户，商户需要接收处理，并按文档规范返回应答。
注意
- 支付结果通知是以POST 方法访问商户设置的通知URL，通知的数据以JSON 格式通过请求主体（BODY）传输。通知的数据包括了加密的支付结果详情
- 加密不能保证通知请求来自微信。微信会对发送给商户的通知进行签名，并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名，以确认请求来自微信，而不是其他的第三方。签名验证的算法请参考 《微信支付API v3签名验证》。
- 支付通知HTTP应答码为200或204才会当作正常接收，当回调处理异常时，应答的HTTP状态码应为500，或者4xx
- 商户成功接收到回调通知后应返回成功的HTTP应答码为200或204
- 同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。 推荐的做法是，当商户系统收到通知进行处理时，先检查对应业务数据的状态，并判断该通知是否已经处理。如果未处理，则再进行处理；如果已处理，则直接返回结果成功。在对业务数据进行状态检查和处理之前，要采用数据锁进行并发控制，以避免函数重入造成的数据混乱
- 对后台通知交互时，如果微信收到商户的应答不符合规范或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。（通知频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 总计 24h4m）
特别提醒： 商户系统对于开启结果通知的内容一定要做签名验证，并校验通知的信息是否与商户侧的信息一致，防止数据泄露导致出现“假通知”，造成资金损失。
更多参数、响应详情及错误码请参见 支付结果通知接口文档。
# 3.2.4. 【服务端】查询订单
步骤说明：当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知时，商户可通过查询订单接口核实订单支付状态
注意
查询订单可通过微信支付订单号和商户订单号两种方式查询，两种查询方式返回结果相同。
需要调用查询接口的情况：
- 当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知。
- 调用支付接口后，返回系统错误或未知交易状态情况。
- 调用付款码支付API，返回USERPAYING的状态。
- 调用关单或撤销接口API之前，需确认支付状态。
示例代码(通过微信订单号查询)：
更多参数、响应详情及错误码请参见 微信支付订单号/商户订单号接口文档。
# 3.2.5. 【服务端】关闭订单
步骤说明：当商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付；系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口
注意
- 关单没有时间限制，建议在订单生成后间隔几分钟（最短5分钟）再调用关单接口，避免出现订单状态同步不及时导致关单失败。
- 已支付成功的订单不能关闭。
更多参数、响应详情及错误码请参见 关闭订单接口文档。
# 3.2.6. 【服务端】申请交易账单
步骤说明： 微信支付按天提供交易账单文件，商户可以通过该接口获取账单文件的下载地址。
更多参数、响应详情及错误码请参见 申请交易账单接口文档。
# 3.2.7. 【服务端】下载账单
步骤说明：通过申请交易账单接口获取到账单下载地址（download_url）后，再通过该接口获取到对应的账单文件，文件内包含交易相关的金额、时间、营销等信息，供商户核对订单、退款、银行到账等情况。
注意
- 账单文件的下载地址的有效时间为30s。
- 强烈建议商户将实际账单文件的哈希值和之前从接口获取到的哈希值进行比对，以确认数据的完整性。
- 该接口响应的信息请求头中不包含微信接口响应的签名值，因此需要跳过验签的流程。
- 微信在次日9点启动生成前一天的对账单，建议商户10点后再获取。
更多参数、响应详情及错误码请参见 下载账单接口文档。
# 4. 常见问题
# Q：在小程序内通过外部H5页面调起支付报错
A：目前在小程序内只支持小程序支付，不支持H5或JSAPI支付。
# Q：调起小程序支付报“商户号该产品权限未开通”
A：请按以下几点进行排查：
- 请检查请求参数是否正确，如请求参数中的AppID是否与小程序对应。
- AppID对应的小程序是否有开通小程序支付功能，权限状态是否正常，可登录商户平台核实。
- AppID与商户号是否存在绑定关系，可登录商户平台核实。
# Q：小程序开通微信支付有哪几种方式？
A：可通过以下两种方式开通:
- 绑定已有公众号的微信支付：耗时10分钟即可，只需原有公众号开通微信支付，小程序微信支付可以选择绑定原来的微信支付商户号，即可开通成功。
- 新申请微信支付：耗时需要1-5个工作日，需要提交和申请小程序一样的资料进行审核，审核通过后才能开通成功。
