com.kdayun.wechat.controller

类 WxPayController

java.lang.Object

com.kdayun.wechat.controller.WxPayController

@RestController
 @RequestMapping(value="wechat/pay")
public class WxPayController
extends java.lang.Object

微信支付

字段概要

字段

限定符和类型	字段和说明
protected javax.servlet.http.HttpServletRequest	req
protected javax.servlet.http.HttpServletResponse	res
(专用程序包) static java.lang.String	WCHAT_PAY_NOTIFY_ORDER_CACHE
(专用程序包) static java.lang.String	WECHAT_PAY_NOTIFY_REFUND_CACHE
(专用程序包) static java.lang.String	WECHAT_PAY_NOTIFY_SCANPAY_CACHE

构造器概要

构造器

构造器和说明
WxPayController()

方法概要

限定符和类型	方法和说明
RetVo	closeOrder(java.lang.String outTradeNo) 关闭订单 应用场景 以下情况需要调用关单接口： 1.
RetVo	closeOrder(com.github.binarywang.wxpay.bean.request.WxPayOrderCloseRequest wxPayOrderCloseRequest)
RetVo	createOrder(com.github.binarywang.wxpay.bean.request.WxPayUnifiedOrderRequest request) 调用统一下单接口，并组装生成支付所需参数对象.
java.lang.String	createScanPayQrcodeMode1(java.lang.String productId) 扫码支付模式一生成二维码的方法 二维码中的内容为链接，形式为： weixin://wxpay/bizpayurl?
byte[]	createScanPayQrcodeMode1(java.lang.String productId, java.io.File logoFile, java.lang.Integer sideLength) 扫码支付模式一生成二维码的方法 二维码中的内容为链接，形式为： weixin://wxpay/bizpayurl?
byte[]	createScanPayQrcodeMode2(java.lang.String codeUrl, java.io.File logoFile, java.lang.Integer sideLength) 扫码支付模式二生成二维码的方法 对应链接格式：weixin：//wxpay/bizpayurl?
RetVo	downloadBill(java.lang.String billDate, java.lang.String billType, java.lang.String tarType, java.lang.String deviceInfo) 下载对账单 商户可以通过该接口下载历史交易清单。
RetVo	downloadBill(com.github.binarywang.wxpay.bean.request.WxPayDownloadBillRequest wxPayDownloadBillRequest)
(专用程序包) java.lang.String	getOrgid(javax.servlet.http.HttpServletRequest request)
RetVo	getSandboxSignKey()
RetVo	micropay(com.github.binarywang.wxpay.bean.request.WxPayMicropayRequest request) 提交刷卡支付 文档地址：https://pay.weixin.qq.com/wiki/doc/api/micropay.php?
java.lang.String	parseOrderNotifyResult(java.lang.String xmlData)
java.lang.String	parseRefundNotifyResult(java.lang.String xmlData)
java.lang.String	parseScanPayNotifyResult(java.lang.String xmlData)
RetVo	queryComment(java.util.Date beginDate, java.util.Date endDate, java.lang.Integer offset, java.lang.Integer limit)
RetVo	queryCouponInfo(com.github.binarywang.wxpay.bean.coupon.WxPayCouponInfoQueryRequest request)
RetVo	queryCouponStock(com.github.binarywang.wxpay.bean.coupon.WxPayCouponStockQueryRequest request)
RetVo	queryOrder(java.lang.String orderId) 这个一般用于前端定时查询订单的支付结果
com.github.binarywang.wxpay.bean.result.WxPayOrderQueryResult	queryOrder(java.lang.String transactionId, java.lang.String outTradeNo) 查询订单(详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?
com.github.binarywang.wxpay.bean.result.WxPayOrderQueryResult	queryOrder(com.github.binarywang.wxpay.bean.request.WxPayOrderQueryRequest wxPayOrderQueryRequest)
RetVo	queryRedpack(java.lang.String mchBillNo) 查询红包记录 用于商户对已发放的红包进行查询红包的具体信息，可支持普通红包和裂变包。
RetVo	refund(com.github.binarywang.wxpay.bean.request.WxPayRefundRequest request) 微信支付-申请退款 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?
RetVo	refundQuery(java.lang.String transactionId, java.lang.String outTradeNo, java.lang.String outRefundNo, java.lang.String refundId) 微信支付-查询退款 应用场景： 提交退款申请后，通过调用该接口查询退款状态。
RetVo	refundQuery(com.github.binarywang.wxpay.bean.request.WxPayRefundQueryRequest wxPayRefundQueryRequest)
void	report(com.github.binarywang.wxpay.bean.request.WxPayReportRequest request) 交易保障 应用场景： 商户在调用微信支付提供的相关接口时，会得到微信支付返回的相关信息以及获得整个接口的响应时间。
RetVo	reverseOrder(com.github.binarywang.wxpay.bean.request.WxPayOrderReverseRequest request) 撤销订单API 文档地址：https://pay.weixin.qq.com/wiki/doc/api/micropay.php?
RetVo	sendCoupon(com.github.binarywang.wxpay.bean.coupon.WxPayCouponSendRequest request)
RetVo	sendRedpack(com.github.binarywang.wxpay.bean.request.WxPaySendRedpackRequest request) 发送微信红包给个人用户 文档详见: 发送普通红包 https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?
void	setReqAndRes(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
RetVo	unifiedOrder(com.github.binarywang.wxpay.bean.request.WxPayUnifiedOrderRequest request) 统一下单(详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

req

protected javax.servlet.http.HttpServletRequest req

res

protected javax.servlet.http.HttpServletResponse res

WCHAT_PAY_NOTIFY_ORDER_CACHE

static java.lang.String WCHAT_PAY_NOTIFY_ORDER_CACHE

WECHAT_PAY_NOTIFY_SCANPAY_CACHE

static java.lang.String WECHAT_PAY_NOTIFY_SCANPAY_CACHE

WECHAT_PAY_NOTIFY_REFUND_CACHE

static java.lang.String WECHAT_PAY_NOTIFY_REFUND_CACHE

构造器详细资料

WxPayController

public WxPayController()

方法详细资料

setReqAndRes

@ModelAttribute
public void setReqAndRes(javax.servlet.http.HttpServletRequest req,
                                          javax.servlet.http.HttpServletResponse res)

queryOrder

@GetMapping(value="/queryOrder")
public com.github.binarywang.wxpay.bean.result.WxPayOrderQueryResult queryOrder(@RequestParam(required=false)
                                                                                                                  java.lang.String transactionId,
                                                                                                                  @RequestParam(required=false)
                                                                                                                  java.lang.String outTradeNo)
                                                                                                           throws java.lang.Exception

 查询订单(详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_2)
 该接口提供所有微信支付订单的查询，商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。
 需要调用查询接口的情况：
 ◆ 当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知；
 ◆ 调用支付接口后，返回系统错误或未知交易状态情况；
 ◆ 调用被扫支付API，返回USERPAYING的状态；
 ◆ 调用关单或撤销接口API之前，需确认支付状态；
 接口地址：https://api.mch.weixin.qq.com/pay/orderquery
 

参数:

transactionId - 微信订单号

outTradeNo - 商户系统内部的订单号，当没提供transactionId时需要传这个。

返回:

WxPayOrderQueryResult

抛出:

java.lang.Exception - 出错会抛出异常

queryOrder

@PostMapping(value="/queryOrder")
public com.github.binarywang.wxpay.bean.result.WxPayOrderQueryResult queryOrder(@RequestBody
                                                                                                                   com.github.binarywang.wxpay.bean.request.WxPayOrderQueryRequest wxPayOrderQueryRequest)
                                                                                                            throws java.lang.Exception

抛出:

java.lang.Exception

closeOrder

@GetMapping(value="/closeOrder/{outTradeNo}")
public RetVo closeOrder(@PathVariable
                                                                       java.lang.String outTradeNo)
                                                                throws java.lang.Exception

 关闭订单
 应用场景
 以下情况需要调用关单接口：
 1. 商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付；
 2. 系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。
 注意：订单生成后不能马上调用关单接口，最短调用时间间隔为5分钟。
 接口地址：https://api.mch.weixin.qq.com/pay/closeorder
 是否需要证书：   不需要。
 

参数:

outTradeNo - 商户系统内部的订单号

返回:

RetVo

抛出:

java.lang.Exception - 出错会抛出异常

closeOrder

@PostMapping(value="/closeOrder")
public RetVo closeOrder(@RequestBody
                                                           com.github.binarywang.wxpay.bean.request.WxPayOrderCloseRequest wxPayOrderCloseRequest)
                                                    throws java.lang.Exception

抛出:

java.lang.Exception

getOrgid

java.lang.String getOrgid(javax.servlet.http.HttpServletRequest request)

createOrder

@PostMapping(value="/createOrder")
public RetVo createOrder(@RequestBody
                                                             com.github.binarywang.wxpay.bean.request.WxPayUnifiedOrderRequest request)
                                                      throws java.lang.Exception

调用统一下单接口，并组装生成支付所需参数对象.

参数:

request - 统一下单请求参数

返回:

返回 RetVo.obj= com.github.binarywang.wxpay.bean.order包下的类对象

抛出:

java.lang.Exception - 出错会抛出异常

unifiedOrder

@PostMapping(value="/unifiedOrder")
public RetVo unifiedOrder(@RequestBody
                                                               com.github.binarywang.wxpay.bean.request.WxPayUnifiedOrderRequest request)
                                                        throws java.lang.Exception

统一下单(详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1) 在发起微信支付前，需要调用统一下单接口，获取"预支付交易会话标识" 接口地址：https://api.mch.weixin.qq.com/pay/unifiedorder

参数:

request - 请求对象，注意一些参数如appid、mchid等不用设置，方法内会自动从配置对象中获取到（前提是对应配置中已经设置）

返回:

RetVo

抛出:

java.lang.Exception - 出错会抛出异常

refund

@PostMapping(value="/refund")
public RetVo refund(@RequestBody
                                                   com.github.binarywang.wxpay.bean.request.WxPayRefundRequest request)
                                            throws java.lang.Exception

 微信支付-申请退款
 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_4
 接口链接：https://api.mch.weixin.qq.com/secapi/pay/refund
 

参数:

request - 请求对象

返回:

退款操作结果

抛出:

java.lang.Exception - 出错会抛出异常

refundQuery

@GetMapping(value="/refundQuery")
public RetVo refundQuery(@RequestParam(required=false)
                                                            java.lang.String transactionId,
                                                            @RequestParam(required=false)
                                                            java.lang.String outTradeNo,
                                                            @RequestParam(required=false)
                                                            java.lang.String outRefundNo,
                                                            @RequestParam(required=false)
                                                            java.lang.String refundId)
                                                     throws java.lang.Exception

 微信支付-查询退款
 应用场景：
  提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，用零钱支付的退款20分钟内到账，
  银行卡支付的退款3个工作日后重新查询退款状态。
 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_5
 接口链接：https://api.mch.weixin.qq.com/pay/refundquery
 

以下四个参数四选一

参数:

transactionId - 微信订单号

outTradeNo - 商户订单号

outRefundNo - 商户退款单号

refundId - 微信退款单号

返回:

退款信息 RetVo.obj= WxPayRefundQueryResult

抛出:

java.lang.Exception - 出错会抛出异常

refundQuery

@PostMapping(value="/refundQuery")
public RetVo refundQuery(@RequestBody
                                                             com.github.binarywang.wxpay.bean.request.WxPayRefundQueryRequest wxPayRefundQueryRequest)
                                                      throws java.lang.Exception

抛出:

java.lang.Exception

parseOrderNotifyResult

@PostMapping(value="/notify/order")
public java.lang.String parseOrderNotifyResult(@RequestBody
                                                                                    java.lang.String xmlData)
                                                                             throws java.lang.Exception

抛出:

java.lang.Exception

queryOrder

@GetMapping(value="query/order")
public RetVo queryOrder(@RequestParam
                                                          java.lang.String orderId)
                                                   throws java.lang.Exception

这个一般用于前端定时查询订单的支付结果

参数:

orderId - 全球唯一的订单号 一般是使用订单的记录的rwid

返回:

RetVo

抛出:

java.lang.Exception - 出错抛出异常

parseRefundNotifyResult

@PostMapping(value="/notify/refund")
public java.lang.String parseRefundNotifyResult(@RequestBody
                                                                                      java.lang.String xmlData)
                                                                               throws java.lang.Exception

抛出:

java.lang.Exception

parseScanPayNotifyResult

@PostMapping(value="/notify/scanpay")
public java.lang.String parseScanPayNotifyResult(java.lang.String xmlData)
                                                                                 throws java.lang.Exception

抛出:

java.lang.Exception

sendRedpack

public RetVo sendRedpack(@RequestBody
                         com.github.binarywang.wxpay.bean.request.WxPaySendRedpackRequest request)
                  throws java.lang.Exception

发送微信红包给个人用户

 文档详见:
 发送普通红包 https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=13_4&index=3
  接口地址：https://api.mch.weixin.qq.com/mmpaymkttransfers/sendredpack
 发送裂变红包 https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=13_5&index=4
  接口地址：https://api.mch.weixin.qq.com/mmpaymkttransfers/sendgroupredpack
 

参数:

request - 请求对象

返回:

RetVo

抛出:

java.lang.Exception - 出错会抛出异常

queryRedpack

@GetMapping(value="/queryRedpack/{mchBillNo}")
public RetVo queryRedpack(@PathVariable
                                                                          java.lang.String mchBillNo)
                                                                   throws java.lang.Exception

   查询红包记录
   用于商户对已发放的红包进行查询红包的具体信息，可支持普通红包和裂变包。
   请求Url        https://api.mch.weixin.qq.com/mmpaymkttransfers/gethbinfo
   是否需要证书       是（证书及使用说明详见商户证书）
   请求方式 POST
 

参数:

mchBillNo - 商户发放红包的商户订单号，比如10000098201411111234567890

返回:

RetVo

抛出:

java.lang.Exception - 出错会抛出异常

createScanPayQrcodeMode1

public byte[] createScanPayQrcodeMode1(java.lang.String productId,
                                       java.io.File logoFile,
                                       java.lang.Integer sideLength)
                                throws java.lang.Exception

 扫码支付模式一生成二维码的方法
 二维码中的内容为链接，形式为：
 weixin://wxpay/bizpayurl?sign=XXXXX&appid=XXXXX&mch_id=XXXXX&product_id=XXXXXX&time_stamp=XXXXXX&nonce_str=XXXXX
 其中XXXXX为商户需要填写的内容，商户将该链接生成二维码，如需要打印发布二维码，需要采用此格式。商户可调用第三方库生成二维码图片。
 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_4
 

参数:

productId - 产品Id

logoFile - 商户logo图片的文件对象，可以为空

sideLength - 要生成的二维码的边长，如果为空，则取默认值400

返回:

生成的二维码的字节数组

抛出:

java.lang.Exception - 出错会抛出异常

createScanPayQrcodeMode1

public java.lang.String createScanPayQrcodeMode1(java.lang.String productId)
                                          throws java.lang.Exception

 扫码支付模式一生成二维码的方法
 二维码中的内容为链接，形式为：
 weixin://wxpay/bizpayurl?sign=XXXXX&appid=XXXXX&mch_id=XXXXX&product_id=XXXXXX&time_stamp=XXXXXX&nonce_str=XXXXX
 其中XXXXX为商户需要填写的内容，商户将该链接生成二维码，如需要打印发布二维码，需要采用此格式。商户可调用第三方库生成二维码图片。
 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_4
 

参数:

productId - 产品Id

返回:

生成的二维码URL连接

抛出:

java.lang.Exception - 出错会抛出异常

createScanPayQrcodeMode2

public byte[] createScanPayQrcodeMode2(java.lang.String codeUrl,
                                       java.io.File logoFile,
                                       java.lang.Integer sideLength)
                                throws java.lang.Exception

 扫码支付模式二生成二维码的方法
 对应链接格式：weixin：//wxpay/bizpayurl?sr=XXXXX。请商户调用第三方库将code_url生成二维码图片。
 该模式链接较短，生成的二维码打印到结账小票上的识别率较高。
 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_5
 

参数:

codeUrl - 微信返回的交易会话的二维码链接

logoFile - 商户logo图片的文件对象，可以为空

sideLength - 要生成的二维码的边长，如果为空，则取默认值400

返回:

生成的二维码的字节数组

抛出:

java.lang.Exception - 出错会抛出异常

report

@PostMapping(value="/report")
public void report(@RequestBody
                                                  com.github.binarywang.wxpay.bean.request.WxPayReportRequest request)
                                           throws java.lang.Exception

 交易保障
 应用场景：
  商户在调用微信支付提供的相关接口时，会得到微信支付返回的相关信息以及获得整个接口的响应时间。
  为提高整体的服务水平，协助商户一起提高服务质量，微信支付提供了相关接口调用耗时和返回信息的主动上报接口，
  微信支付可以根据商户侧上报的数据进一步优化网络部署，完善服务监控，和商户更好的协作为用户提供更好的业务体验。
 接口地址： https://api.mch.weixin.qq.com/payitil/report
 是否需要证书：不需要
 

参数:

request - 请求对象

抛出:

java.lang.Exception - 出错会抛出异常

downloadBill

@GetMapping(value="/downloadBill/{billDate}/{billType}/{tarType}/{deviceInfo}")
public RetVo downloadBill(@PathVariable
                                                                                                           java.lang.String billDate,
                                                                                                           @PathVariable
                                                                                                           java.lang.String billType,
                                                                                                           @PathVariable
                                                                                                           java.lang.String tarType,
                                                                                                           @PathVariable
                                                                                                           java.lang.String deviceInfo)
                                                                                                    throws java.lang.Exception

 下载对账单
 商户可以通过该接口下载历史交易清单。比如掉单、系统错误等导致商户侧和微信侧数据不一致，通过对账单核对后可校正支付状态。
 注意：
 1、微信侧未成功下单的交易不会出现在对账单中。支付成功后撤销的交易会出现在对账单中，跟原支付单订单号一致，bill_type为REVOKED；
 2、微信在次日9点启动生成前一天的对账单，建议商户10点后再获取；
 3、对账单中涉及金额的字段单位为“元”。
 4、对账单接口只能下载三个月以内的账单。
 接口链接：https://api.mch.weixin.qq.com/pay/downloadbill
 详情请见: 下载对账单
 

参数:

billDate - 对账单日期 bill_date 下载对账单的日期，格式：20140603

billType - 账单类型 bill_type ALL，返回当日所有订单信息，默认值，SUCCESS，返回当日成功支付的订单，REFUND，返回当日退款订单

tarType - 压缩账单 tar_type 非必传参数，固定值：GZIP，返回格式为.gzip的压缩包账单。不传则默认为数据流形式。

deviceInfo - 设备号 device_info 非必传参数，终端设备号

返回:

保存到本地的临时文件

抛出:

java.lang.Exception - 出错会抛出异常

downloadBill

@PostMapping(value="/downloadBill")
public RetVo downloadBill(com.github.binarywang.wxpay.bean.request.WxPayDownloadBillRequest wxPayDownloadBillRequest)
                                                        throws java.lang.Exception

抛出:

java.lang.Exception

micropay

@PostMapping(value="/micropay")
public RetVo micropay(@RequestBody
                                                       com.github.binarywang.wxpay.bean.request.WxPayMicropayRequest request)
                                                throws java.lang.Exception

 提交刷卡支付
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_10&index=1
 应用场景：
 收银员使用扫码设备读取微信用户刷卡授权码以后，二维码或条码信息传送至商户收银台，由商户收银台或者商户后台调用该接口发起支付。
 提醒1：提交支付请求后微信会同步返回支付结果。当返回结果为“系统错误”时，商户系统等待5秒后调用【查询订单API】，查询支付实际交易结果；当返回结果为“USERPAYING”时，商户系统可设置间隔时间(建议10秒)重新查询支付结果，直到支付成功或超时(建议30秒)；
 提醒2：在调用查询接口返回后，如果交易状况不明晰，请调用【撤销订单API】，此时如果交易失败则关闭订单，该单不能再支付成功；如果交易成功，则将扣款退回到用户账户。当撤销无返回或错误时，请再次调用。注意：请勿扣款后立即调用【撤销订单API】,建议至少15秒后再调用。撤销订单API需要双向证书。
 接口地址：   https://api.mch.weixin.qq.com/pay/micropay
 是否需要证书：不需要。
 

参数:

request - 请求对象

返回:

RetVo

抛出:

java.lang.Exception - 出错会抛出异常

reverseOrder

@PostMapping(value="/reverseOrder")
public RetVo reverseOrder(@RequestBody
                                                               com.github.binarywang.wxpay.bean.request.WxPayOrderReverseRequest request)
                                                        throws java.lang.Exception

 撤销订单API
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_11&index=3
 应用场景：
  支付交易返回失败或支付系统超时，调用该接口撤销交易。如果此订单用户支付失败，微信支付系统会将此订单关闭；如果用户支付成功，微信支付系统会将此订单资金退还给用户。
  注意：7天以内的交易单可调用撤销，其他正常支付的单如需实现相同功能请调用申请退款API。提交支付交易后调用【查询订单API】，没有明确的支付结果再调用【撤销订单API】。
  调用支付接口后请勿立即调用撤销订单API，建议支付后至少15s后再调用撤销订单接口。
  接口链接 ：https://api.mch.weixin.qq.com/secapi/pay/reverse
  是否需要证书：请求需要双向证书。
 

参数:

request - 请求对象

返回:

RetVo

抛出:

java.lang.Exception - 出错会抛出异常

getSandboxSignKey

@GetMapping(value="/getSandboxSignKey")
public RetVo getSandboxSignKey()
                                                                 throws java.lang.Exception

抛出:

java.lang.Exception

sendCoupon

@PostMapping(value="/sendCoupon")
public RetVo sendCoupon(@RequestBody
                                                           com.github.binarywang.wxpay.bean.coupon.WxPayCouponSendRequest request)
                                                    throws java.lang.Exception

抛出:

java.lang.Exception

queryCouponStock

@PostMapping(value="/queryCouponStock")
public RetVo queryCouponStock(@RequestBody
                                                                       com.github.binarywang.wxpay.bean.coupon.WxPayCouponStockQueryRequest request)
                                                                throws java.lang.Exception

抛出:

java.lang.Exception

queryCouponInfo

@PostMapping(value="/queryCouponInfo")
public RetVo queryCouponInfo(@RequestBody
                                                                     com.github.binarywang.wxpay.bean.coupon.WxPayCouponInfoQueryRequest request)
                                                              throws java.lang.Exception

抛出:

java.lang.Exception

queryComment

@PostMapping(value="/queryComment")
public RetVo queryComment(java.util.Date beginDate,
                                                               java.util.Date endDate,
                                                               java.lang.Integer offset,
                                                               java.lang.Integer limit)
                                                        throws java.lang.Exception

抛出:

java.lang.Exception