BaseWxPayServiceImpl (WxJava - PAY Java SDK 3.6.0 API)

java.lang.Object
- com.github.binarywang.wxpay.service.impl.BaseWxPayServiceImpl

所有已实现的接口:: WxPayService

直接已知子类:: WxPayServiceApacheHttpImpl, WxPayServiceJoddHttpImpl

public abstract class BaseWxPayServiceImpl
extends Object
implements WxPayService

  微信支付接口请求抽象实现类
 Created by Binary Wang on 2017-7-8.

作者:: Binary Wang

字段概要

字段
限定符和类型字段和说明

protected WxPayConfig config
The Config.

字段
限定符和类型	字段和说明
`protected WxPayConfig`	`config` The Config.

构造器概要

构造器
构造器和说明

BaseWxPayServiceImpl()

构造器
构造器和说明
`BaseWxPayServiceImpl()`

方法概要

All Methods Instance Methods Concrete Methods Deprecated Methods
限定符和类型	方法和说明
`String`	`authcode2Openid(String authCode)` 授权码查询OPENID接口.
`String`	`authcode2Openid(WxPayAuthcode2OpenidRequest request)` 授权码查询OPENID接口.
`WxPayOrderCloseResult`	`closeOrder(String outTradeNo)` 关闭订单.
`WxPayOrderCloseResult`	`closeOrder(WxPayOrderCloseRequest request)` 关闭订单（适合于需要自定义子商户号和子商户appid的情形）.
`<T> T`	`createOrder(WxPayUnifiedOrderRequest request)` 调用统一下单接口，并组装生成支付所需参数对象.
`String`	`createScanPayQrcodeMode1(String productId)` 扫码支付模式一生成二维码的方法.
`byte[]`	`createScanPayQrcodeMode1(String productId, File logoFile, Integer sideLength)` 扫码支付模式一生成二维码的方法。
`byte[]`	`createScanPayQrcodeMode2(String codeUrl, File logoFile, Integer sideLength)` 扫码支付模式二生成二维码的方法.
`WxPayBillResult`	`downloadBill(String billDate, String billType, String tarType, String deviceInfo)` 下载对账单.
`WxPayBillResult`	`downloadBill(WxPayDownloadBillRequest request)` 下载对账单（适合于需要自定义子商户号和子商户appid的情形）.
`WxPayFundFlowResult`	`downloadFundFlow(String billDate, String accountType, String tarType)` 下载资金账单.
`WxPayFundFlowResult`	`downloadFundFlow(WxPayDownloadFundFlowRequest request)` 下载资金账单.
`String`	`downloadRawBill(String billDate, String billType, String tarType, String deviceInfo)` 下载对账单.
`String`	`downloadRawBill(WxPayDownloadBillRequest request)` 下载对账单（适合于需要自定义子商户号和子商户appid的情形）.
`WxPayFacepayResult`	`facepay(WxPayFacepayRequest request)` 提交刷脸支付.
`WxPayConfig`	`getConfig()` 获取配置.
`EntPayService`	`getEntPayService()` 获取企业付款服务类.
`String`	`getPayBaseUrl()` 获取微信支付请求url前缀，沙箱环境可能不一样.
`Map<String,String>`	`getPayInfo(WxPayUnifiedOrderRequest request)` 已过时。
`ProfitSharingService`	`getProfitSharingService()` 获取分账服务类.
`String`	`getSandboxSignKey()` 获取仿真测试系统的验签密钥.
`WxPayApiData`	`getWxApiData()` 获取微信请求数据，方便接口调用方获取处理.
`WxPayFaceAuthInfoResult`	`getWxPayFaceAuthInfo(WxPayFaceAuthInfoRequest request)` 获取微信刷脸支付凭证.
`WxPayMicropayResult`	`micropay(WxPayMicropayRequest request)` 提交刷卡支付.
`WxPayOrderNotifyResult`	`parseOrderNotifyResult(String xmlData)` 解析支付结果通知.
`WxPayRefundNotifyResult`	`parseRefundNotifyResult(String xmlData)` 解析退款结果通知详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?
`WxScanPayNotifyResult`	`parseScanPayNotifyResult(String xmlData)` 解析扫码支付回调通知详见https://pay.weixin.qq.com/wiki/doc/api/native.php?
`String`	`queryComment(Date beginDate, Date endDate, Integer offset, Integer limit)` 拉取订单评价数据.
`String`	`queryComment(WxPayQueryCommentRequest request)` 拉取订单评价数据.
`WxPayCouponInfoQueryResult`	`queryCouponInfo(WxPayCouponInfoQueryRequest request)` 查询代金券信息.
`WxPayCouponStockQueryResult`	`queryCouponStock(WxPayCouponStockQueryRequest request)` 查询代金券批次.
`WxPayOrderQueryResult`	`queryOrder(String transactionId, String outTradeNo)` 查询订单.
`WxPayOrderQueryResult`	`queryOrder(WxPayOrderQueryRequest request)` 查询订单（适合于需要自定义子商户号和子商户appid的情形）.
`WxPayRedpackQueryResult`	`queryRedpack(String mchBillNo)` 查询红包记录.
`WxPayRedpackQueryResult`	`queryRedpack(WxPayRedpackQueryRequest request)` 查询红包记录.
`WxPayRefundResult`	`refund(WxPayRefundRequest request)` 微信支付-申请退款.
`WxPayRefundQueryResult`	`refundQuery(String transactionId, String outTradeNo, String outRefundNo, String refundId)` 微信支付-查询退款.
`WxPayRefundQueryResult`	`refundQuery(WxPayRefundQueryRequest request)` 微信支付-查询退款（适合于需要自定义子商户号和子商户appid的情形）.
`void`	`report(WxPayReportRequest request)` 交易保障.
`WxPayOrderReverseResult`	`reverseOrder(WxPayOrderReverseRequest request)` 撤销订单API.
`WxPayCouponSendResult`	`sendCoupon(WxPayCouponSendRequest request)` 发放代金券接口请求链接：https://api.mch.weixin.qq.com/mmpaymkttransfers/send_coupon 是否需要证书：请求需要双向证书。
`WxPaySendRedpackResult`	`sendRedpack(WxPaySendRedpackRequest request)` 发送微信红包给个人用户.
`void`	`setConfig(WxPayConfig config)` 设置配置对象.
`void`	`setEntPayService(EntPayService entPayService)` 设置企业付款服务类，允许开发者自定义实现类.
`String`	`shorturl(String longUrl)` 转换短链接.
`String`	`shorturl(WxPayShorturlRequest request)` 转换短链接.
`WxPayUnifiedOrderResult`	`unifiedOrder(WxPayUnifiedOrderRequest request)` 统一下单(详见https://pay.weixin.qq.com/wiki/doc/api/app/app.php?

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.github.binarywang.wxpay.service.WxPayService
post, postForBytes

字段详细资料
- config
```
protected WxPayConfig config
```
  The Config.

构造器详细资料
- BaseWxPayServiceImpl
```
public BaseWxPayServiceImpl()
```

方法详细资料

getEntPayService
```
public EntPayService getEntPayService()
```
从接口复制的说明: WxPayService

获取企业付款服务类.

指定者:

getEntPayService 在接口中 WxPayService

返回:

the ent pay service

getProfitSharingService
```
public ProfitSharingService getProfitSharingService()
```
从接口复制的说明: WxPayService

获取分账服务类.

指定者:

getProfitSharingService 在接口中 WxPayService

返回:

the ent pay service

setEntPayService
```
public void setEntPayService(EntPayService entPayService)
```
从接口复制的说明: WxPayService

设置企业付款服务类，允许开发者自定义实现类.

指定者:

setEntPayService 在接口中 WxPayService

参数:

entPayService - the ent pay service

getConfig
```
public WxPayConfig getConfig()
```
从接口复制的说明: WxPayService

获取配置.

指定者:

getConfig 在接口中 WxPayService

返回:

the config

setConfig
```
public void setConfig(WxPayConfig config)
```
从接口复制的说明: WxPayService

设置配置对象.

指定者:

setConfig 在接口中 WxPayService

参数:

config - the config

getPayBaseUrl
```
public String getPayBaseUrl()
```
从接口复制的说明: WxPayService

获取微信支付请求url前缀，沙箱环境可能不一样.

指定者:

getPayBaseUrl 在接口中 WxPayService

返回:

the pay base url

refund

public WxPayRefundResult refund(WxPayRefundRequest request)
                         throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: refund 在接口中 WxPayService
参数:: request - 请求对象
返回:: 退款操作结果 wx pay refund result
抛出:: WxPayException - the wx pay exception

refundQuery

public WxPayRefundQueryResult refundQuery(String transactionId,
                                          String outTradeNo,
                                          String outRefundNo,
                                          String refundId)
                                   throws WxPayException

从接口复制的说明: WxPayService

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

以下四个参数四选一

指定者:: refundQuery 在接口中 WxPayService
参数:: transactionId - 微信订单号; outTradeNo - 商户订单号; outRefundNo - 商户退款单号; refundId - 微信退款单号
返回:: 退款信息 wx pay refund query result
抛出:: WxPayException - the wx pay exception

refundQuery

public WxPayRefundQueryResult refundQuery(WxPayRefundQueryRequest request)
                                   throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: refundQuery 在接口中 WxPayService
参数:: request - 微信退款单号
返回:: 退款信息 wx pay refund query result
抛出:: WxPayException - the wx pay exception

parseOrderNotifyResult
```
public WxPayOrderNotifyResult parseOrderNotifyResult(String xmlData)
                                              throws WxPayException
```
从接口复制的说明: WxPayService

解析支付结果通知. 详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_7

指定者:

parseOrderNotifyResult 在接口中 WxPayService

参数:

xmlData - the xml data

返回:

the wx pay order notify result

抛出:

WxPayException - the wx pay exception

parseRefundNotifyResult
```
public WxPayRefundNotifyResult parseRefundNotifyResult(String xmlData)
                                                throws WxPayException
```
从接口复制的说明: WxPayService

解析退款结果通知详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_16&index=9

指定者:

parseRefundNotifyResult 在接口中 WxPayService

参数:

xmlData - the xml data

返回:

the wx pay refund notify result

抛出:

WxPayException - the wx pay exception

parseScanPayNotifyResult
```
public WxScanPayNotifyResult parseScanPayNotifyResult(String xmlData)
                                               throws WxPayException
```
从接口复制的说明: WxPayService

解析扫码支付回调通知详见https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_4

指定者:

parseScanPayNotifyResult 在接口中 WxPayService

参数:

xmlData - the xml data

返回:

the wx scan pay notify result

抛出:

WxPayException - the wx pay exception

sendRedpack

public WxPaySendRedpackResult sendRedpack(WxPaySendRedpackRequest request)
                                   throws WxPayException

从接口复制的说明: WxPayService

发送微信红包给个人用户.

 文档详见:
 发送普通红包 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

指定者:: sendRedpack 在接口中 WxPayService
参数:: request - 请求对象
返回:: the wx pay send redpack result
抛出:: WxPayException - the wx pay exception

queryRedpack

public WxPayRedpackQueryResult queryRedpack(String mchBillNo)
                                     throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: queryRedpack 在接口中 WxPayService
参数:: mchBillNo - 商户发放红包的商户订单号，比如10000098201411111234567890
返回:: the wx pay redpack query result
抛出:: WxPayException - the wx pay exception

queryRedpack

public WxPayRedpackQueryResult queryRedpack(WxPayRedpackQueryRequest request)
                                     throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: queryRedpack 在接口中 WxPayService
参数:: request - 红包查询请求
返回:: the wx pay redpack query result
抛出:: WxPayException - the wx pay exception

queryOrder

public WxPayOrderQueryResult queryOrder(String transactionId,
                                        String outTradeNo)
                                 throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: queryOrder 在接口中 WxPayService
参数:: transactionId - 微信订单号; outTradeNo - 商户系统内部的订单号，当没提供transactionId时需要传这个。
返回:: the wx pay order query result
抛出:: WxPayException - the wx pay exception

queryOrder

public WxPayOrderQueryResult queryOrder(WxPayOrderQueryRequest request)
                                 throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: queryOrder 在接口中 WxPayService
参数:: request - 查询订单请求对象
返回:: the wx pay order query result
抛出:: WxPayException - the wx pay exception

closeOrder

public WxPayOrderCloseResult closeOrder(String outTradeNo)
                                 throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: closeOrder 在接口中 WxPayService
参数:: outTradeNo - 商户系统内部的订单号
返回:: the wx pay order close result
抛出:: WxPayException - the wx pay exception

closeOrder

public WxPayOrderCloseResult closeOrder(WxPayOrderCloseRequest request)
                                 throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: closeOrder 在接口中 WxPayService
参数:: request - 关闭订单请求对象
返回:: the wx pay order close result
抛出:: WxPayException - the wx pay exception

createOrder
```
public <T> T createOrder(WxPayUnifiedOrderRequest request)
                  throws WxPayException
```
从接口复制的说明: WxPayService

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

指定者:

createOrder 在接口中 WxPayService

类型参数:

T - 请使用com.github.binarywang.wxpay.bean.order包下的类

参数:

request - 统一下单请求参数

返回:

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

抛出:

WxPayException - the wx pay exception

unifiedOrder
```
public WxPayUnifiedOrderResult unifiedOrder(WxPayUnifiedOrderRequest request)
                                     throws WxPayException
```
从接口复制的说明: WxPayService

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

指定者:

unifiedOrder 在接口中 WxPayService

参数:

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

返回:

the wx pay unified order result

抛出:

WxPayException - the wx pay exception

getPayInfo
```
@Deprecated
public Map<String,String> getPayInfo(WxPayUnifiedOrderRequest request)
                                           throws WxPayException
```
已过时。

从接口复制的说明: WxPayService

该接口调用“统一下单”接口，并拼装发起支付请求需要的参数. 详见https://pay.weixin.qq.com/wiki/doc/api/app/app.php?chapter=8_5

指定者:

getPayInfo 在接口中 WxPayService

参数:

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

返回:

the pay info

抛出:

WxPayException - the wx pay exception

createScanPayQrcodeMode1

public byte[] createScanPayQrcodeMode1(String productId,
                                       File logoFile,
                                       Integer sideLength)

从接口复制的说明: WxPayService

 扫码支付模式一生成二维码的方法。
 二维码中的内容为链接，形式为：
 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

指定者:: createScanPayQrcodeMode1 在接口中 WxPayService
参数:: productId - 产品Id; logoFile - 商户logo图片的文件对象，可以为空; sideLength - 要生成的二维码的边长，如果为空，则取默认值400
返回:: 生成的二维码的字节数组 byte [ ]

createScanPayQrcodeMode1

public String createScanPayQrcodeMode1(String productId)

从接口复制的说明: WxPayService

 扫码支付模式一生成二维码的方法.
 二维码中的内容为链接，形式为：
 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

指定者:: createScanPayQrcodeMode1 在接口中 WxPayService
参数:: productId - 产品Id
返回:: 生成的二维码URL连接 string

createScanPayQrcodeMode2

public byte[] createScanPayQrcodeMode2(String codeUrl,
                                       File logoFile,
                                       Integer sideLength)

从接口复制的说明: WxPayService

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

指定者:: createScanPayQrcodeMode2 在接口中 WxPayService
参数:: codeUrl - 微信返回的交易会话的二维码链接; logoFile - 商户logo图片的文件对象，可以为空; sideLength - 要生成的二维码的边长，如果为空，则取默认值400
返回:: 生成的二维码的字节数组 byte [ ]

report

public void report(WxPayReportRequest request)
            throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: report 在接口中 WxPayService
参数:: request - the request
抛出:: WxPayException - the wx pay exception

downloadRawBill

public String downloadRawBill(String billDate,
                              String billType,
                              String tarType,
                              String deviceInfo)
                       throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: downloadRawBill 在接口中 WxPayService
参数:: billDate - 对账单日期 bill_date 下载对账单的日期，格式：20140603; billType - 账单类型 bill_type ALL，返回当日所有订单信息，默认值，SUCCESS，返回当日成功支付的订单，REFUND，返回当日退款订单; tarType - 压缩账单 tar_type 非必传参数，固定值：GZIP，返回格式为.gzip的压缩包账单。不传则默认为数据流形式。; deviceInfo - 设备号 device_info 非必传参数，终端设备号
返回:: 对账内容原始字符串
抛出:: WxPayException - the wx pay exception

downloadBill

public WxPayBillResult downloadBill(String billDate,
                                    String billType,
                                    String tarType,
                                    String deviceInfo)
                             throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: downloadBill 在接口中 WxPayService
参数:: billDate - 对账单日期 bill_date 下载对账单的日期，格式：20140603; billType - 账单类型 bill_type ALL，返回当日所有订单信息，默认值，SUCCESS，返回当日成功支付的订单，REFUND，返回当日退款订单; tarType - 压缩账单 tar_type 非必传参数，固定值：GZIP，返回格式为.gzip的压缩包账单。不传则默认为数据流形式。; deviceInfo - 设备号 device_info 非必传参数，终端设备号
返回:: WxPayBillResult对象 wx pay bill result
抛出:: WxPayException - the wx pay exception

downloadBill

public WxPayBillResult downloadBill(WxPayDownloadBillRequest request)
                             throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: downloadBill 在接口中 WxPayService
参数:: request - 下载对账单请求
返回:: WxPayBillResult对象 wx pay bill result
抛出:: WxPayException - the wx pay exception

downloadRawBill

public String downloadRawBill(WxPayDownloadBillRequest request)
                       throws WxPayException

从接口复制的说明: WxPayService

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

指定者:: downloadRawBill 在接口中 WxPayService
参数:: request - 下载对账单请求
返回:: 对账内容原始字符串
抛出:: WxPayException - the wx pay exception

downloadFundFlow

public WxPayFundFlowResult downloadFundFlow(String billDate,
                                            String accountType,
                                            String tarType)
                                     throws WxPayException

从接口复制的说明: WxPayService

 下载资金账单.
 商户可以通过该接口下载自2017年6月1日起 的历史资金流水账单。
 注意：
 1、资金账单中的数据反映的是商户微信账户资金变动情况；
 2、当日账单在次日上午9点开始生成，建议商户在上午10点以后获取；
 3、资金账单中涉及金额的字段单位为“元”。
 接口链接：https://api.mch.weixin.qq.com/pay/downloadfundflow
 详情请见: 下载对账单

指定者:: downloadFundFlow 在接口中 WxPayService
参数:: billDate - 资金账单日期 bill_date 下载对账单的日期，格式：20140603; accountType - 资金账户类型 account_type Basic，基本账户，Operation，运营账户，Fees，手续费账户; tarType - 压缩账单 tar_type 非必传参数，固定值：GZIP，返回格式为.gzip的压缩包账单。不传则默认为数据流形式。
返回:: WxPayFundFlowResult对象 wx pay fund flow result
抛出:: WxPayException - the wx pay exception

downloadFundFlow

public WxPayFundFlowResult downloadFundFlow(WxPayDownloadFundFlowRequest request)
                                     throws WxPayException

从接口复制的说明: WxPayService

 下载资金账单.
 商户可以通过该接口下载自2017年6月1日起 的历史资金流水账单。
 注意：
 1、资金账单中的数据反映的是商户微信账户资金变动情况；
 2、当日账单在次日上午9点开始生成，建议商户在上午10点以后获取；
 3、资金账单中涉及金额的字段单位为“元”。
 接口链接：https://api.mch.weixin.qq.com/pay/downloadfundflow
 详情请见: 下载对账单

指定者:: downloadFundFlow 在接口中 WxPayService
参数:: request - 下载资金流水请求
返回:: WxPayFundFlowResult对象 wx pay fund flow result
抛出:: WxPayException - the wx pay exception

micropay

public WxPayMicropayResult micropay(WxPayMicropayRequest request)
                             throws WxPayException

从接口复制的说明: WxPayService

 提交刷卡支付.
 文档地址：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
 是否需要证书：不需要。

指定者:: micropay 在接口中 WxPayService
参数:: request - the request
返回:: the wx pay micropay result
抛出:: WxPayException - the wx pay exception

reverseOrder

public WxPayOrderReverseResult reverseOrder(WxPayOrderReverseRequest request)
                                     throws WxPayException

从接口复制的说明: WxPayService

 撤销订单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
  是否需要证书：请求需要双向证书。

指定者:: reverseOrder 在接口中 WxPayService
参数:: request - the request
返回:: the wx pay order reverse result
抛出:: WxPayException - the wx pay exception

shorturl

public String shorturl(WxPayShorturlRequest request)
                throws WxPayException

从接口复制的说明: WxPayService

  转换短链接.
  文档地址：
     https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_9&index=8
  应用场景：
     该接口主要用于扫码原生支付模式一中的二维码链接转成短链接(weixin://wxpay/s/XXXXXX)，减小二维码数据量，提升扫描速度和精确度。
  接口地址：https://api.mch.weixin.qq.com/tools/shorturl
  是否需要证书：否

指定者:: shorturl 在接口中 WxPayService
参数:: request - 请求对象
返回:: the string
抛出:: WxPayException - the wx pay exception

shorturl
```
public String shorturl(String longUrl)
                throws WxPayException
```
从接口复制的说明: WxPayService
```
  转换短链接.
 
```
指定者:

shorturl 在接口中 WxPayService

参数:

longUrl - 需要被压缩的网址

返回:

the string

抛出:

WxPayException - the wx pay exception

另请参阅:

WxPayService#shorturl(WxPayShorturlRequest)

authcode2Openid

public String authcode2Openid(WxPayAuthcode2OpenidRequest request)
                       throws WxPayException

从接口复制的说明: WxPayService

 授权码查询OPENID接口.
    通过授权码查询公众号Openid，调用查询后，该授权码只能由此商户号发起扣款，直至授权码更新。
 文档地址：
    https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_13&index=9
 接口链接:
    https://api.mch.weixin.qq.com/tools/authcodetoopenid

指定者:: authcode2Openid 在接口中 WxPayService
参数:: request - 请求对象
返回:: openid string
抛出:: WxPayException - the wx pay exception

authcode2Openid
```
public String authcode2Openid(String authCode)
                       throws WxPayException
```
从接口复制的说明: WxPayService
```
 授权码查询OPENID接口.
 
```
指定者:

authcode2Openid 在接口中 WxPayService

参数:

authCode - 授权码

返回:

openid string

抛出:

WxPayException - the wx pay exception

另请参阅:

WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest)

getSandboxSignKey

public String getSandboxSignKey()
                         throws WxPayException

从接口复制的说明: WxPayService

 获取仿真测试系统的验签密钥.
 请求Url： https://api.mch.weixin.qq.com/sandboxnew/pay/getsignkey
 是否需要证书： 否
 请求方式： POST
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=23_1

指定者:: getSandboxSignKey 在接口中 WxPayService
返回:: the sandbox sign key
抛出:: WxPayException - the wx pay exception

sendCoupon

public WxPayCouponSendResult sendCoupon(WxPayCouponSendRequest request)
                                 throws WxPayException

从接口复制的说明: WxPayService

 发放代金券
 接口请求链接：https://api.mch.weixin.qq.com/mmpaymkttransfers/send_coupon
 是否需要证书：请求需要双向证书。
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/tools/sp_coupon.php?chapter=12_3

指定者:: sendCoupon 在接口中 WxPayService
参数:: request - the request
返回:: the wx pay coupon send result
抛出:: WxPayException - the wx pay exception

queryCouponStock

public WxPayCouponStockQueryResult queryCouponStock(WxPayCouponStockQueryRequest request)
                                             throws WxPayException

从接口复制的说明: WxPayService

 查询代金券批次.
 接口请求链接：https://api.mch.weixin.qq.com/mmpaymkttransfers/query_coupon_stock
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/tools/sp_coupon.php?chapter=12_4

指定者:: queryCouponStock 在接口中 WxPayService
参数:: request - the request
返回:: the wx pay coupon stock query result
抛出:: WxPayException - the wx pay exception

queryCouponInfo

public WxPayCouponInfoQueryResult queryCouponInfo(WxPayCouponInfoQueryRequest request)
                                           throws WxPayException

从接口复制的说明: WxPayService

 查询代金券信息.
 接口请求链接：https://api.mch.weixin.qq.com/mmpaymkttransfers/querycouponsinfo
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/tools/sp_coupon.php?chapter=12_5

指定者:: queryCouponInfo 在接口中 WxPayService
参数:: request - the request
返回:: the wx pay coupon info query result
抛出:: WxPayException - the wx pay exception

getWxApiData
```
public WxPayApiData getWxApiData()
```
从接口复制的说明: WxPayService

获取微信请求数据，方便接口调用方获取处理.

指定者:

getWxApiData 在接口中 WxPayService

返回:

the wx api data

queryComment

public String queryComment(Date beginDate,
                           Date endDate,
                           Integer offset,
                           Integer limit)
                    throws WxPayException

从接口复制的说明: WxPayService

 拉取订单评价数据.
 商户可以通过该接口拉取用户在微信支付交易记录中针对你的支付记录进行的评价内容。商户可结合商户系统逻辑对该内容数据进行存储、分析、展示、客服回访以及其他使用。如商户业务对评价内容有依赖，可主动引导用户进入微信支付交易记录进行评价。
 注意：
 1. 该内容所有权为提供内容的微信用户，商户在使用内容的过程中应遵从用户意愿
 2. 一次最多拉取200条评价数据，可根据时间区间分批次拉取
 3. 接口只能拉取最近三个月以内的评价数据
 接口链接：https://api.mch.weixin.qq.com/billcommentsp/batchquerycomment
 是否需要证书：需要
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_17&index=10

指定者:: queryComment 在接口中 WxPayService
参数:: beginDate - 开始时间; endDate - 结束时间; offset - 位移; limit - 条数，建议填null，否则接口会报签名错误
返回:: the string
抛出:: WxPayException - the wx pay exception

queryComment

public String queryComment(WxPayQueryCommentRequest request)
                    throws WxPayException

从接口复制的说明: WxPayService

 拉取订单评价数据.
 商户可以通过该接口拉取用户在微信支付交易记录中针对你的支付记录进行的评价内容。商户可结合商户系统逻辑对该内容数据进行存储、分析、展示、客服回访以及其他使用。如商户业务对评价内容有依赖，可主动引导用户进入微信支付交易记录进行评价。
 注意：
 1. 该内容所有权为提供内容的微信用户，商户在使用内容的过程中应遵从用户意愿
 2. 一次最多拉取200条评价数据，可根据时间区间分批次拉取
 3. 接口只能拉取最近三个月以内的评价数据
 接口链接：https://api.mch.weixin.qq.com/billcommentsp/batchquerycomment
 是否需要证书：需要
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_17&index=10

指定者:: queryComment 在接口中 WxPayService
参数:: request - 查询请求
返回:: the string
抛出:: WxPayException - the wx pay exception

getWxPayFaceAuthInfo

public WxPayFaceAuthInfoResult getWxPayFaceAuthInfo(WxPayFaceAuthInfoRequest request)
                                             throws WxPayException

从接口复制的说明: WxPayService

 获取微信刷脸支付凭证.
 接口请求链接：https://payapp.weixin.qq.com/face/get_wxpayface_authinfo
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/tools/sp_coupon.php?chapter=12_5

指定者:: getWxPayFaceAuthInfo 在接口中 WxPayService
参数:: request - the request
返回:: the wx pay get face authinfo result
抛出:: WxPayException - the wx pay exception

facepay

public WxPayFacepayResult facepay(WxPayFacepayRequest request)
                           throws WxPayException

从接口复制的说明: WxPayService

 提交刷脸支付.
 文档地址：https://share.weiyun.com/5dxUgCw
 应用场景：
 用户在商超，便利店，餐饮等场景，在屏幕上通过刷脸完成支付。
 步骤1：用户在自助收银机上点击“刷脸支付”；
 步骤2：发起人脸识别，摄像头自动抓取识别用户人脸，提示用户输入11位手机号码；
 步骤3：商户收银系统提交刷脸支付；
 步骤4：微信支付后台收到支付请求，验证人脸信息，返回支付结果给商户收银系统。
 是否需要证书：不需要。

指定者:: facepay 在接口中 WxPayService
参数:: request - the request
返回:: the wx pay facepay result
抛出:: WxPayException - the wx pay exception

类 BaseWxPayServiceImpl

字段概要

构造器概要

方法概要

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

从接口继承的方法 com.github.binarywang.wxpay.service.WxPayService

字段详细资料

config

构造器详细资料

BaseWxPayServiceImpl

方法详细资料

getEntPayService

getProfitSharingService

setEntPayService

getConfig

setConfig

getPayBaseUrl

refund

refundQuery

refundQuery

parseOrderNotifyResult

parseRefundNotifyResult

parseScanPayNotifyResult

sendRedpack

queryRedpack

queryRedpack

queryOrder

queryOrder

closeOrder

closeOrder

createOrder

unifiedOrder

getPayInfo

createScanPayQrcodeMode1

createScanPayQrcodeMode1

createScanPayQrcodeMode2

report

downloadRawBill

downloadBill

downloadBill

downloadRawBill

downloadFundFlow

downloadFundFlow

micropay

reverseOrder

shorturl

shorturl

authcode2Openid

authcode2Openid

getSandboxSignKey

sendCoupon

queryCouponStock

queryCouponInfo

getWxApiData

queryComment

queryComment

getWxPayFaceAuthInfo

facepay