com.github.binarywang.wxpay.service

接口 WxPayService

所有已知实现类:

BaseWxPayServiceImpl, WxPayServiceApacheHttpImpl, WxPayServiceImpl, WxPayServiceJoddHttpImpl

public interface WxPayService

 微信支付相关接口.
 Created by Binary Wang on 2016/7/28.
 

作者:

Binary Wang

方法概要

限定符和类型	方法和说明
void	addConfig(String mchId, WxPayConfig wxPayConfig) Map里 加入新的 WxPayConfig，适用于动态添加新的微信公众号配置.
WxPayApplyBillV3Result	applyFundFlowBill(WxPayApplyFundFlowBillV3Request request) 申请资金账单API 微信支付按天提供微信支付账户的资金流水账单文件，商户可以通过该接口获取账单文件的下载地址。
WxPayApplyBillV3Result	applyTradeBill(WxPayApplyTradeBillV3Request request) 申请交易账单API 微信支付按天提供交易账单文件，商户可以通过该接口获取账单文件的下载地址。
String	authcode2Openid(String authCode) 授权码查询OPENID接口.
String	authcode2Openid(WxPayAuthcode2OpenidRequest request) 授权码查询OPENID接口.
void	closeCombine(CombineCloseRequest request) 合单关闭订单API 请求URL: https://api.mch.weixin.qq.com/v3/combine-transactions/out-trade-no/{combine_out_trade_no}/close 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_12.shtml
WxPayOrderCloseResult	closeOrder(String outTradeNo) 关闭订单.
WxPayOrderCloseResult	closeOrder(WxPayOrderCloseRequest request) 关闭订单（适合于需要自定义子商户号和子商户appid的情形）.
void	closeOrderV3(String outTradeNo) 关闭订单 应用场景 以下情况需要调用关单接口： 1、商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付； 2、系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。
void	closeOrderV3(WxPayOrderCloseV3Request request) 关闭订单 应用场景 以下情况需要调用关单接口： 1、商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付； 2、系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。
CombineTransactionsResult	combine(TradeTypeEnum tradeType, CombineTransactionsRequest request) 合单支付API(APP支付、JSAPI支付、H5支付、NATIVE支付).
<T> T	combineTransactions(TradeTypeEnum tradeType, CombineTransactionsRequest request) 合单支付API(APP支付、JSAPI支付、H5支付、NATIVE支付).
<T> T	createOrder(WxPayConstants.TradeType.Specific<T> specificTradeType, WxPayUnifiedOrderRequest request) 调用统一下单接口，并组装生成支付所需参数对象.
<T> T	createOrder(WxPayUnifiedOrderRequest request) 调用统一下单接口，并组装生成支付所需参数对象.
<T> T	createOrderV3(TradeTypeEnum tradeType, WxPayUnifiedOrderV3Request request) 调用统一下单接口，并组装生成支付所需参数对象.
String	createScanPayQrcodeMode1(String productId) 扫码支付模式一生成二维码的方法.
byte[]	createScanPayQrcodeMode1(String productId, File logoFile, Integer sideLength) 扫码支付模式一生成二维码的方法。
byte[]	createScanPayQrcodeMode2(String codeUrl, File logoFile, Integer sideLength) 扫码支付模式二生成二维码的方法.
InputStream	downloadBill(String url) 下载账单API 下载账单API为通用接口，交易/资金账单都可以通过该接口获取到对应的账单。
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的情形）.
InputStream	downloadV3(String url) 发送下载 V3请求，得到响应流.
WxPayFacepayResult	facepay(WxPayFacepayRequest request) 提交刷脸支付.
BusinessCircleService	getBusinessCircleService() 获取微信支付智慧商圈服务类
WxPayConfig	getConfig() 获取配置.
EcommerceService	getEcommerceService() 获取电商收付通服务类
EntPayService	getEntPayService() 获取企业付款服务类.
MarketingBusiFavorService	getMarketingBusiFavorService() 获取微信支付营销商家券服务类
MarketingFavorService	getMarketingFavorService() 获取微信支付营销代金券服务类
MarketingMediaService	getMarketingMediaService() 获取微信支付营销媒体服务类
MerchantMediaService	getMerchantMediaService() 获取微信支付通用媒体服务类
String	getPayBaseUrl() 获取微信支付请求url前缀，沙箱环境可能不一样.
Map<String,String>	getPayInfo(WxPayUnifiedOrderRequest request) 已过时。 建议使用 createOrder(WxPayUnifiedOrderRequest)
PayScoreService	getPayScoreService() 获取支付分服务类.
ProfitSharingService	getProfitSharingService() 获取分账服务类.
ProfitSharingV3Service	getProfitSharingV3Service() 获取V3分账服务类.
RedpackService	getRedpackService() 获取红包接口服务类.
String	getSandboxSignKey() 获取仿真测试系统的验签密钥.
String	getV3(String url) 发送get V3请求，得到响应字符串.
WxPayApiData	getWxApiData() 获取微信请求数据，方便接口调用方获取处理.
WxPayFaceAuthInfoResult	getWxPayFaceAuthInfo(WxPayFaceAuthInfoRequest request) 获取微信刷脸支付凭证.
WxPayMicropayResult	micropay(WxPayMicropayRequest request) 提交付款码支付.
CombineNotifyResult	parseCombineNotifyResult(String notifyData, SignatureHeader header) 合单支付通知回调数据处理 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_13.shtml
WxPayOrderNotifyResult	parseOrderNotifyResult(String xmlData) 解析支付结果通知.
WxPayOrderNotifyResult	parseOrderNotifyResult(String xmlData, String signType) 解析支付结果通知.
WxPayOrderNotifyV3Result	parseOrderNotifyV3Result(String notifyData, SignatureHeader header) 解析支付结果v3通知.
WxPayRefundNotifyResult	parseRefundNotifyResult(String xmlData) 解析退款结果通知 详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?
WxPayRefundNotifyV3Result	parseRefundNotifyV3Result(String notifyData, SignatureHeader header) 解析退款结果通知 详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?
WxScanPayNotifyResult	parseScanPayNotifyResult(String xmlData) 解析扫码支付回调通知 详见https://pay.weixin.qq.com/wiki/doc/api/native.php?
WxScanPayNotifyResult	parseScanPayNotifyResult(String xmlData, String signType) 解析扫码支付回调通知 详见https://pay.weixin.qq.com/wiki/doc/api/native.php?
String	patchV3(String url, String requestStr) 发送patch请求，得到响应字符串.
String	post(String url, String requestStr, boolean useKey) 发送post请求，得到响应字符串.
byte[]	postForBytes(String url, String requestStr, boolean useKey) 发送post请求，得到响应字节数组.
String	postV3(String url, org.apache.http.client.methods.HttpPost httpPost) 发送post请求，得到响应字符串.
String	postV3(String url, String requestStr) 发送post请求，得到响应字符串.
String	postV3WithWechatpaySerial(String url, String requestStr) 发送post请求，得到响应字符串.
CombineQueryResult	queryCombine(String combineOutTradeNo) 合单查询订单API 请求URL: https://api.mch.weixin.qq.com/v3/combine-transactions/out-trade-no/{combine_out_trade_no} 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_11.shtml
String	queryComment(Date beginDate, Date endDate, Integer offset, Integer limit) 拉取订单评价数据.
String	queryComment(WxPayQueryCommentRequest request) 拉取订单评价数据.
WxPayCouponInfoQueryResult	queryCouponInfo(WxPayCouponInfoQueryRequest request) 查询代金券信息.
WxPayCouponStockQueryResult	queryCouponStock(WxPayCouponStockQueryRequest request) 查询代金券批次.
WxPayQueryExchangeRateResult	queryExchangeRate(String feeType, String date) 查询汇率 应用场景：商户网站的商品以外币标价时，通过该接口可以实时查询到微信使用的转换汇率。
WxPayOrderQueryResult	queryOrder(String transactionId, String outTradeNo) 查询订单.
WxPayOrderQueryResult	queryOrder(WxPayOrderQueryRequest request) 查询订单（适合于需要自定义子商户号和子商户appid的情形）.
WxPayOrderQueryV3Result	queryOrderV3(String transactionId, String outTradeNo) 查询订单 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml 商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。
WxPayOrderQueryV3Result	queryOrderV3(WxPayOrderQueryV3Request request) 查询订单 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml 商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。
WxPayRefundResult	refund(WxPayRefundRequest request) 微信支付-申请退款.
WxPayRefundQueryResult	refundQuery(String transactionId, String outTradeNo, String outRefundNo, String refundId) 微信支付-查询退款.
WxPayRefundQueryResult	refundQuery(WxPayRefundQueryRequest request) 微信支付-查询退款（适合于需要自定义子商户号和子商户appid的情形）.
WxPayRefundQueryResult	refundQueryV2(WxPayRefundQueryRequest request) 微信支付-查询退款API（支持单品）.
WxPayRefundQueryV3Result	refundQueryV3(String outTradeNo) 微信支付-查询退款 应用场景： 提交退款申请后，通过调用该接口查询退款状态。
WxPayRefundQueryV3Result	refundQueryV3(WxPayRefundQueryV3Request request) 微信支付-查询退款 应用场景： 提交退款申请后，通过调用该接口查询退款状态。
WxPayRefundResult	refundV2(WxPayRefundRequest request) 申请退款API（支持单品）.
WxPayRefundV3Result	refundV3(WxPayRefundV3Request request) 申请退款API（支持单品）.
void	removeConfig(String mchId) 从 Map中 移除 mchId 所对应的 WxPayConfig，适用于动态移除微信公众号配置.
void	report(WxPayReportRequest request) 交易保障.
String	requestV3(String url, org.apache.http.client.methods.HttpRequestBase httpRequest) 发送http请求，得到响应字符串.
WxPayOrderReverseResult	reverseOrder(WxPayOrderReverseRequest request) 撤销订单API.
WxPayCouponSendResult	sendCoupon(WxPayCouponSendRequest request) 发放代金券 接口请求链接：https://api.mch.weixin.qq.com/mmpaymkttransfers/send_coupon 是否需要证书：请求需要双向证书。
void	setConfig(WxPayConfig config) 设置配置对象.
void	setEntPayService(EntPayService entPayService) 设置企业付款服务类，允许开发者自定义实现类.
void	setMultiConfig(Map<String,WxPayConfig> wxPayConfigs) 注入多个 WxPayConfig 的实现.
void	setMultiConfig(Map<String,WxPayConfig> wxPayConfigs, String defaultMchId) 注入多个 WxPayConfig 的实现.
String	shorturl(String longUrl) 转换短链接.
String	shorturl(WxPayShorturlRequest request) 转换短链接.
boolean	switchover(String mchId) 进行相应的公众号切换.
WxPayService	switchoverTo(String mchId) 进行相应的公众号切换.
WxPayUnifiedOrderResult	unifiedOrder(WxPayUnifiedOrderRequest request) 统一下单(详见https://pay.weixin.qq.com/wiki/doc/api/app/app.php?
WxPayUnifiedOrderV3Result	unifiedOrderV3(TradeTypeEnum tradeType, WxPayUnifiedOrderV3Request request) 在发起微信支付前，需要调用统一下单接口，获取"预支付交易会话标识"

方法详细资料

getPayBaseUrl

String getPayBaseUrl()

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

返回:

the pay base url

addConfig

void addConfig(String mchId,
               WxPayConfig wxPayConfig)

Map里 加入新的 WxPayConfig，适用于动态添加新的微信公众号配置.

参数:

mchId - 商户号id

wxPayConfig - 新的微信配置

removeConfig

void removeConfig(String mchId)

从 Map中 移除 mchId 所对应的 WxPayConfig，适用于动态移除微信公众号配置.

参数:

mchId - 对应公众号的标识

setMultiConfig

void setMultiConfig(Map<String,WxPayConfig> wxPayConfigs)

注入多个 WxPayConfig 的实现. 并为每个 WxPayConfig 赋予不同的 mchId 值 随机采用一个mchId进行Http初始化操作

参数:

wxPayConfigs - WxPayConfig map

setMultiConfig

void setMultiConfig(Map<String,WxPayConfig> wxPayConfigs,
                    String defaultMchId)

注入多个 WxPayConfig 的实现. 并为每个 WxPayConfig 赋予不同的 label 值

参数:

wxPayConfigs - WxPayConfig map

defaultMchId - 设置一个WxPayConfig 所对应的mchId进行Http初始化

switchover

boolean switchover(String mchId)

进行相应的公众号切换.

参数:

mchId - 公众号标识

返回:

切换是否成功 boolean

switchoverTo

WxPayService switchoverTo(String mchId)

进行相应的公众号切换.

参数:

mchId - 公众号标识

返回:

切换成功 ，则返回当前对象，方便链式调用，否则抛出异常

postForBytes

byte[] postForBytes(String url,
                    String requestStr,
                    boolean useKey)
             throws WxPayException

发送post请求，得到响应字节数组.

参数:

url - 请求地址

requestStr - 请求信息

useKey - 是否使用证书

返回:

返回请求结果字节数组 byte [ ]

抛出:

WxPayException - the wx pay exception

post

String post(String url,
            String requestStr,
            boolean useKey)
     throws WxPayException

发送post请求，得到响应字符串.

参数:

url - 请求地址

requestStr - 请求信息

useKey - 是否使用证书

返回:

返回请求结果字符串 string

抛出:

WxPayException - the wx pay exception

postV3

String postV3(String url,
              String requestStr)
       throws WxPayException

发送post请求，得到响应字符串.

参数:

url - 请求地址

requestStr - 请求信息

返回:

返回请求结果字符串 string

抛出:

WxPayException - the wx pay exception

patchV3

String patchV3(String url,
               String requestStr)
        throws WxPayException

发送patch请求，得到响应字符串.

参数:

url - 请求地址

requestStr - 请求信息

返回:

返回请求结果字符串 string

抛出:

WxPayException - the wx pay exception

postV3WithWechatpaySerial

String postV3WithWechatpaySerial(String url,
                                 String requestStr)
                          throws WxPayException

发送post请求，得到响应字符串.

部分字段会包含敏感信息，所以在提交前需要在请求头中会包含"Wechatpay-Serial"信息

参数:

url - 请求地址

requestStr - 请求信息

返回:

返回请求结果字符串 string

抛出:

WxPayException - the wx pay exception

postV3

String postV3(String url,
              org.apache.http.client.methods.HttpPost httpPost)
       throws WxPayException

发送post请求，得到响应字符串.

参数:

url - 请求地址

httpPost - 请求信息

返回:

返回请求结果字符串 string

抛出:

WxPayException - the wx pay exception

requestV3

String requestV3(String url,
                 org.apache.http.client.methods.HttpRequestBase httpRequest)
          throws WxPayException

发送http请求，得到响应字符串.

参数:

url - 请求地址

httpRequest - 请求信息，可以是put，post，get，delete等请求

返回:

返回请求结果字符串 string

抛出:

WxPayException - the wx pay exception

getV3

String getV3(String url)
      throws WxPayException

发送get V3请求，得到响应字符串.

参数:

url - 请求地址

返回:

返回请求结果字符串 string

抛出:

WxPayException - the wx pay exception

downloadV3

InputStream downloadV3(String url)
                throws WxPayException

发送下载 V3请求，得到响应流.

参数:

url - 请求地址

返回:

返回请求响应流 input stream

抛出:

WxPayException - the wx pay exception

getEntPayService

EntPayService getEntPayService()

获取企业付款服务类.

返回:

the ent pay service

getRedpackService

RedpackService getRedpackService()

获取红包接口服务类.

返回:

. redpack service

getProfitSharingService

ProfitSharingService getProfitSharingService()

获取分账服务类.

V3接口 getProfitSharingV3Service()

返回:

the ent pay service

getProfitSharingV3Service

ProfitSharingV3Service getProfitSharingV3Service()

获取V3分账服务类.

返回:

the ent pay service

getPayScoreService

PayScoreService getPayScoreService()

获取支付分服务类.

返回:

the ent pay service

getEcommerceService

EcommerceService getEcommerceService()

获取电商收付通服务类

返回:

the ecommerce service

getBusinessCircleService

BusinessCircleService getBusinessCircleService()

获取微信支付智慧商圈服务类

返回:

the business circle service

getMerchantMediaService

MerchantMediaService getMerchantMediaService()

获取微信支付通用媒体服务类

返回:

the merchant media service

getMarketingMediaService

MarketingMediaService getMarketingMediaService()

获取微信支付营销媒体服务类

返回:

the marketing media service

getMarketingFavorService

MarketingFavorService getMarketingFavorService()

获取微信支付营销代金券服务类

返回:

the marketing favor service

getMarketingBusiFavorService

MarketingBusiFavorService getMarketingBusiFavorService()

获取微信支付营销商家券服务类

返回:

the marketing favor service

setEntPayService

void setEntPayService(EntPayService entPayService)

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

参数:

entPayService - the ent pay service

queryOrder

WxPayOrderQueryResult queryOrder(String transactionId,
                                 String outTradeNo)
                          throws WxPayException

 查询订单.
 详见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时需要传这个。

返回:

the wx pay order query result

抛出:

WxPayException - the wx pay exception

queryOrder

WxPayOrderQueryResult queryOrder(WxPayOrderQueryRequest request)
                          throws WxPayException

 查询订单（适合于需要自定义子商户号和子商户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
 

参数:

request - 查询订单请求对象

返回:

the wx pay order query result

抛出:

WxPayException - the wx pay exception

queryOrderV3

WxPayOrderQueryV3Result queryOrderV3(String transactionId,
                                     String outTradeNo)
                              throws WxPayException

 查询订单
 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml
 商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。查询订单状态可通过微信支付订单号或商户订单号两种方式查询
 注意：
  查询订单可通过微信支付订单号和商户订单号两种方式查询，两种查询方式返回结果相同
 需要调用查询接口的情况：
 ◆ 当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知。
 ◆ 调用支付接口后，返回系统错误或未知交易状态情况。
 ◆ 调用付款码支付API，返回USERPAYING的状态。
 ◆ 调用关单或撤销接口API之前，需确认支付状态。
 接口地址：
  https://api.mch.weixin.qq.com/v3/pay/transactions/id/{transaction_id}
  https://api.mch.weixin.qq.com/v3/pay/transactions/out-trade-no/{out_trade_no}
 

参数:

transactionId - 微信订单号

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

返回:

the wx pay order query result

抛出:

WxPayException - the wx pay exception

queryOrderV3

WxPayOrderQueryV3Result queryOrderV3(WxPayOrderQueryV3Request request)
                              throws WxPayException

 查询订单
 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml
 商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。查询订单状态可通过微信支付订单号或商户订单号两种方式查询
 注意：
  查询订单可通过微信支付订单号和商户订单号两种方式查询，两种查询方式返回结果相同
 需要调用查询接口的情况：
 ◆ 当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知。
 ◆ 调用支付接口后，返回系统错误或未知交易状态情况。
 ◆ 调用付款码支付API，返回USERPAYING的状态。
 ◆ 调用关单或撤销接口API之前，需确认支付状态。
 接口地址：
  https://api.mch.weixin.qq.com/v3/pay/transactions/id/{transaction_id}
  https://api.mch.weixin.qq.com/v3/pay/transactions/out-trade-no/{out_trade_no}
 

参数:

request - 查询订单请求对象

返回:

the wx pay order query result

抛出:

WxPayException - the wx pay exception

queryCombine

CombineQueryResult queryCombine(String combineOutTradeNo)
                         throws WxPayException

 合单查询订单API
 请求URL: https://api.mch.weixin.qq.com/v3/combine-transactions/out-trade-no/{combine_out_trade_no}
 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_11.shtml
 

参数:

combineOutTradeNo - 合单商户订单号

返回:

合单支付订单信息

抛出:

WxPayException - the wx pay exception

closeOrder

WxPayOrderCloseResult closeOrder(String outTradeNo)
                          throws WxPayException

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

参数:

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

返回:

the wx pay order close result

抛出:

WxPayException - the wx pay exception

closeOrder

WxPayOrderCloseResult closeOrder(WxPayOrderCloseRequest request)
                          throws WxPayException

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

参数:

request - 关闭订单请求对象

返回:

the wx pay order close result

抛出:

WxPayException - the wx pay exception

closeOrderV3

void closeOrderV3(String outTradeNo)
           throws WxPayException

 关闭订单
 应用场景
 以下情况需要调用关单接口：
 1、商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付；
 2、系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。
 注意：关单没有时间限制，建议在订单生成后间隔几分钟（最短5分钟）再调用关单接口，避免出现订单状态同步不及时导致关单失败。
 接口地址：https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_3.shtml
 

参数:

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

抛出:

WxPayException - the wx pay exception

closeOrderV3

void closeOrderV3(WxPayOrderCloseV3Request request)
           throws WxPayException

 关闭订单
 应用场景
 以下情况需要调用关单接口：
 1、商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付；
 2、系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。
 注意：关单没有时间限制，建议在订单生成后间隔几分钟（最短5分钟）再调用关单接口，避免出现订单状态同步不及时导致关单失败。
 接口地址：https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_3.shtml
 

参数:

request - 关闭订单请求对象

抛出:

WxPayException - the wx pay exception

closeCombine

void closeCombine(CombineCloseRequest request)
           throws WxPayException

 合单关闭订单API
 请求URL: https://api.mch.weixin.qq.com/v3/combine-transactions/out-trade-no/{combine_out_trade_no}/close
 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_12.shtml
 

参数:

request - 请求对象

抛出:

WxPayException - the wx pay exception

createOrder

<T> T createOrder(WxPayUnifiedOrderRequest request)
           throws WxPayException

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

类型参数:

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

参数:

request - 统一下单请求参数

返回:

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

抛出:

WxPayException - the wx pay exception

createOrder

<T> T createOrder(WxPayConstants.TradeType.Specific<T> specificTradeType,
                  WxPayUnifiedOrderRequest request)
           throws WxPayException

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

类型参数:

T - the type parameter

参数:

specificTradeType - 将使用的交易方式，不能为 null

request - 统一下单请求参数，设定的 tradeType 及配置里的 tradeType 将被忽略，转而使用 specificTradeType

返回:

返回 WxPayConstants.TradeType.Specific 指定的类

抛出:

WxPayException - the wx pay exception

另请参阅:

WxPayService#createOrder(WxPayUnifiedOrderRequest)

unifiedOrder

WxPayUnifiedOrderResult unifiedOrder(WxPayUnifiedOrderRequest request)
                              throws WxPayException

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

参数:

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

返回:

the wx pay unified order result

抛出:

WxPayException - the wx pay exception

createOrderV3

<T> T createOrderV3(TradeTypeEnum tradeType,
                    WxPayUnifiedOrderV3Request request)
             throws WxPayException

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

类型参数:

T - 请使用WxPayUnifiedOrderV3Result里的内部类或字段

参数:

request - 统一下单请求参数

返回:

返回 WxPayUnifiedOrderV3Result里的内部类或字段

抛出:

WxPayException - the wx pay exception

unifiedOrderV3

WxPayUnifiedOrderV3Result unifiedOrderV3(TradeTypeEnum tradeType,
                                         WxPayUnifiedOrderV3Request request)
                                  throws WxPayException

在发起微信支付前，需要调用统一下单接口，获取"预支付交易会话标识"

参数:

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

返回:

the wx pay unified order result

抛出:

WxPayException - the wx pay exception

combine

CombineTransactionsResult combine(TradeTypeEnum tradeType,
                                  CombineTransactionsRequest request)
                           throws WxPayException

 合单支付API(APP支付、JSAPI支付、H5支付、NATIVE支付).
 请求URL:
  https://api.mch.weixin.qq.com/v3/combine-transactions/app
  https://api.mch.weixin.qq.com/v3/combine-transactions/h5
  https://api.mch.weixin.qq.com/v3/combine-transactions/jsapi
  https://api.mch.weixin.qq.com/v3/combine-transactions/native
 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/open/pay/chapter2_9_3.shtml
 

参数:

tradeType - 支付方式

request - 请求对象

返回:

微信合单支付返回 combine transactions result

抛出:

WxPayException - the wx pay exception

combineTransactions

<T> T combineTransactions(TradeTypeEnum tradeType,
                          CombineTransactionsRequest request)
                   throws WxPayException

 合单支付API(APP支付、JSAPI支付、H5支付、NATIVE支付).
 请求URL:
  https://api.mch.weixin.qq.com/v3/combine-transactions/app
  https://api.mch.weixin.qq.com/v3/combine-transactions/h5
  https://api.mch.weixin.qq.com/v3/combine-transactions/jsapi
  https://api.mch.weixin.qq.com/v3/combine-transactions/native
 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/open/pay/chapter2_9_3.shtml
 

参数:

tradeType - 支付方式

request - 请求对象

返回:

调起支付需要的参数 t

抛出:

WxPayException - the wx pay exception

getPayInfo

@Deprecated
Map<String,String> getPayInfo(WxPayUnifiedOrderRequest request)
                                    throws WxPayException

已过时。 建议使用 createOrder(WxPayUnifiedOrderRequest)

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

参数:

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

返回:

the pay info

抛出:

WxPayException - the wx pay exception

getConfig

WxPayConfig getConfig()

获取配置.

返回:

the config

setConfig

void setConfig(WxPayConfig config)

设置配置对象.

参数:

config - the config

refund

WxPayRefundResult refund(WxPayRefundRequest request)
                  throws WxPayException

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

参数:

request - 请求对象

返回:

退款操作结果 wx pay refund result

抛出:

WxPayException - the wx pay exception

refundV2

WxPayRefundResult refundV2(WxPayRefundRequest request)
                    throws WxPayException

 申请退款API（支持单品）.
 详见 https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_103&index=3

 应用场景
 当交易发生之后一段时间内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付款退还给买家，微信支付将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退到买家帐号上。

 注意：
 1、交易时间超过一年的订单无法提交退款；
 2、微信支付退款支持单笔交易分多次退款，多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。 一笔退款失败后重新提交，请不要更换退款单号，请使用原商户退款单号。
 3、请求频率限制：150qps，即每秒钟正常的申请退款请求次数不超过150次
     错误或无效请求频率限制：6qps，即每秒钟异常或错误的退款申请请求不超过6次
 4、每个支付订单的部分退款次数不能超过50次
 5、本接口支持单品优惠订单全额退款和单品优惠订单部分退款，推荐使用本接口，如果使用不支持单品优惠部分退款的历史接口，请看https://pay.weixin.qq.com/wiki/doc/api/jsapi_sl.php?chapter=9_4

 接口地址
 https://api.mch.weixin.qq.com/secapi/pay/refundv2
 https://api2.mch.weixin.qq.com/secapi/pay/refundv2(备用域名)见跨城冗灾方案
 

参数:

request - 请求对象

返回:

退款操作结果 wx pay refund result

抛出:

WxPayException - the wx pay exception

refundV3

WxPayRefundV3Result refundV3(WxPayRefundV3Request request)
                      throws WxPayException

 申请退款API（支持单品）.
 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_9.shtml

 应用场景
 当交易发生之后一年内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付金额退还给买家，微信支付将在收到退款请求并且验证成功之后，将支付款按原路退还至买家账号上。

 注意：
 1、交易时间超过一年的订单无法提交退款
 2、微信支付退款支持单笔交易分多次退款（不超50次），多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。 一笔退款失败后重新提交，请不要更换退款单号，请使用原商户退款单号
 3、错误或无效请求频率限制：6qps，即每秒钟异常或错误的退款申请请求不超过6次
 4、每个支付订单的部分退款次数不能超过50次
 5、如果同一个用户有多笔退款，建议分不同批次进行退款，避免并发退款导致退款失败
 6、申请退款接口的返回仅代表业务的受理情况，具体退款是否成功，需要通过退款查询接口获取结果
 7、一个月之前的订单申请退款频率限制为：5000/min

 接口地址
 https://api.mch.weixin.qq.com/v3/refund/domestic/refunds
 

参数:

request - 请求对象

返回:

退款操作结果 wx pay refund result

抛出:

WxPayException - the wx pay exception

refundQuery

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

 微信支付-查询退款.
 应用场景：
  提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，用零钱支付的退款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 - 微信退款单号

返回:

退款信息 wx pay refund query result

抛出:

WxPayException - the wx pay exception

refundQuery

WxPayRefundQueryResult refundQuery(WxPayRefundQueryRequest request)
                            throws WxPayException

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

参数:

request - 微信退款单号

返回:

退款信息 wx pay refund query result

抛出:

WxPayException - the wx pay exception

refundQueryV2

WxPayRefundQueryResult refundQueryV2(WxPayRefundQueryRequest request)
                              throws WxPayException

 微信支付-查询退款API（支持单品）.
 应用场景
    提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，用零钱支付的退款20分钟内到账，银行卡支付的退款3个工作日后重新查询退款状态。
 注意：
 1、本接口支持查询单品优惠相关退款信息，且仅支持按微信退款单号或商户退款单号查询，若继续调用老查询退款接口，
    请见https://pay.weixin.qq.com/wiki/doc/api/jsapi_sl.php?chapter=9_5
 2、请求频率限制：300qps，即每秒钟正常的退款查询请求次数不超过300次
 3、错误或无效请求频率限制：6qps，即每秒钟异常或错误的退款查询请求不超过6次

 接口地址
 https://api.mch.weixin.qq.com/pay/refundqueryv2
 https://api2.mch.weixin.qq.com/pay/refundqueryv2(备用域名)见跨城冗灾方案
 详见 https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_104&index=4
 

参数:

request - 微信退款单号

返回:

退款信息 wx pay refund query result

抛出:

WxPayException - the wx pay exception

refundQueryV3

WxPayRefundQueryV3Result refundQueryV3(String outTradeNo)
                                throws WxPayException

 微信支付-查询退款
 应用场景：
  提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，建议在提交退款申请后1分钟发起查询退款状态，一般来说零钱支付的退款5分钟内到账，银行卡支付的退款1-3个工作日到账。
  详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_10.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/refund/domestic/refunds/{out_refund_no}
 

参数:

outTradeNo - 商户订单号

返回:

退款信息 wx pay refund query result

抛出:

WxPayException - the wx pay exception

refundQueryV3

WxPayRefundQueryV3Result refundQueryV3(WxPayRefundQueryV3Request request)
                                throws WxPayException

 微信支付-查询退款
 应用场景：
  提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，建议在提交退款申请后1分钟发起查询退款状态，一般来说零钱支付的退款5分钟内到账，银行卡支付的退款1-3个工作日到账。
  详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_10.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/refund/domestic/refunds/{out_refund_no}
 

参数:

request - 微信退款单号

返回:

退款信息 wx pay refund query result

抛出:

WxPayException - the wx pay exception

parseOrderNotifyResult

WxPayOrderNotifyResult parseOrderNotifyResult(String xmlData)
                                       throws WxPayException

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

参数:

xmlData - the xml data

返回:

the wx pay order notify result

抛出:

WxPayException - the wx pay exception

parseOrderNotifyResult

WxPayOrderNotifyResult parseOrderNotifyResult(String xmlData,
                                              String signType)
                                       throws WxPayException

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

参数:

xmlData - the xml data

signType - 签名类型

返回:

the wx pay order notify result

抛出:

WxPayException - the wx pay exception

parseOrderNotifyV3Result

WxPayOrderNotifyV3Result parseOrderNotifyV3Result(String notifyData,
                                                  SignatureHeader header)
                                           throws WxPayException

解析支付结果v3通知. 详见https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_5.shtml

参数:

notifyData - 通知数据

header - 通知头部数据，不传则表示不校验头

返回:

the wx pay order notify result

抛出:

WxPayException - the wx pay exception

parseCombineNotifyResult

CombineNotifyResult parseCombineNotifyResult(String notifyData,
                                             SignatureHeader header)
                                      throws WxPayException

 合单支付通知回调数据处理
 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_13.shtml
 

参数:

notifyData - 通知数据

header - 通知头部数据，不传则表示不校验头

返回:

解密后通知数据 combine transactions notify result

抛出:

WxPayException - the wx pay exception

parseRefundNotifyResult

WxPayRefundNotifyResult parseRefundNotifyResult(String xmlData)
                                         throws WxPayException

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

参数:

xmlData - the xml data

返回:

the wx pay refund notify result

抛出:

WxPayException - the wx pay exception

parseRefundNotifyV3Result

WxPayRefundNotifyV3Result parseRefundNotifyV3Result(String notifyData,
                                                    SignatureHeader header)
                                             throws WxPayException

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

参数:

notifyData - 通知数据

header - 通知头部数据，不传则表示不校验头

返回:

the wx pay refund notify result

抛出:

WxPayException - the wx pay exception

parseScanPayNotifyResult

WxScanPayNotifyResult parseScanPayNotifyResult(String xmlData,
                                               String signType)
                                        throws WxPayException

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

参数:

xmlData - the xml data

signType - 签名类型

返回:

the wx scan pay notify result

抛出:

WxPayException - the wx pay exception

parseScanPayNotifyResult

WxScanPayNotifyResult parseScanPayNotifyResult(String xmlData)
                                        throws WxPayException

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

参数:

xmlData - the xml data

返回:

the wx scan pay notify result

抛出:

WxPayException - the wx pay exception

createScanPayQrcodeMode1

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

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

返回:

生成的二维码的字节数组 byte [ ]

createScanPayQrcodeMode1

String createScanPayQrcodeMode1(String productId)

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

createScanPayQrcodeMode2

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

 扫码支付模式二生成二维码的方法.
 对应链接格式：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

返回:

生成的二维码的字节数组 byte [ ]

report

void report(WxPayReportRequest request)
     throws WxPayException

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

参数:

request - the request

抛出:

WxPayException - the wx pay exception

downloadRawBill

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

 下载对账单.
 商户可以通过该接口下载历史交易清单。比如掉单、系统错误等导致商户侧和微信侧数据不一致，通过对账单核对后可校正支付状态。
 注意：
 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 非必传参数，终端设备号

返回:

对账内容原始字符串 string

抛出:

WxPayException - the wx pay exception

downloadRawBill

String downloadRawBill(WxPayDownloadBillRequest request)
                throws WxPayException

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

参数:

request - 下载对账单请求

返回:

对账内容原始字符串 string

抛出:

WxPayException - the wx pay exception

downloadBill

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

 下载对账单.
 商户可以通过该接口下载历史交易清单。比如掉单、系统错误等导致商户侧和微信侧数据不一致，通过对账单核对后可校正支付状态。
 注意：
 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 非必传参数，终端设备号

返回:

WxPayBillResult对象 wx pay bill result

抛出:

WxPayException - the wx pay exception

downloadBill

WxPayBillResult downloadBill(WxPayDownloadBillRequest request)
                      throws WxPayException

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

参数:

request - 下载对账单请求

返回:

WxPayBillResult对象 wx pay bill result

抛出:

WxPayException - the wx pay exception

downloadFundFlow

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

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

参数:

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

WxPayFundFlowResult downloadFundFlow(WxPayDownloadFundFlowRequest request)
                              throws WxPayException

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

参数:

request - 下载资金流水请求

返回:

WxPayFundFlowResult对象 wx pay fund flow result

抛出:

WxPayException - the wx pay exception

applyTradeBill

WxPayApplyBillV3Result applyTradeBill(WxPayApplyTradeBillV3Request request)
                               throws WxPayException

 申请交易账单API
 微信支付按天提供交易账单文件，商户可以通过该接口获取账单文件的下载地址。文件内包含交易相关的金额、时间、营销等信息，供商户核对订单、退款、银行到账等情况。
 注意：
 • 微信侧未成功下单的交易不会出现在对账单中。支付成功后撤销的交易会出现在对账单中，跟原支付单订单号一致；
 • 对账单中涉及金额的字段单位为“元”；
 • 对账单接口只能下载三个月以内的账单。
 接口链接：https://api.mch.weixin.qq.com/v3/bill/tradebill
 详情请见: 申请交易账单
 

参数:

request - 申请账单请求

返回:

Result对象 apply trade bill result

抛出:

WxPayException - the wx pay exception

applyFundFlowBill

WxPayApplyBillV3Result applyFundFlowBill(WxPayApplyFundFlowBillV3Request request)
                                  throws WxPayException

 申请资金账单API
 微信支付按天提供微信支付账户的资金流水账单文件，商户可以通过该接口获取账单文件的下载地址。文件内包含该账户资金操作相关的业务单号、收支金额、记账时间等信息，供商户进行核对。
 注意：
 • 资金账单中的数据反映的是商户微信支付账户资金变动情况；
 • 对账单中涉及金额的字段单位为“元”。
 接口链接：https://api.mch.weixin.qq.com/v3/bill/fundflowbill
 详情请见: 申请资金账单
 

参数:

request - 申请账单请求

返回:

Result对象 apply fund flow bill result

抛出:

WxPayException - the wx pay exception

downloadBill

InputStream downloadBill(String url)
                  throws WxPayException

 下载账单API
 下载账单API为通用接口，交易/资金账单都可以通过该接口获取到对应的账单。
 注意：
 • 账单文件的下载地址的有效时间为30s。
 • 强烈建议商户将实际账单文件的哈希值和之前从接口获取到的哈希值进行比对，以确认数据的完整性。
 • 该接口响应的信息请求头中不包含微信接口响应的签名值，因此需要跳过验签的流程
 接口链接：通过申请账单接口获取到“download_url”，URL有效期30s
 详情请见: 下载账单
 

参数:

url - 微信返回的账单地址。

返回:

返回数据 return input stream

抛出:

WxPayException - the wx pay exception

micropay

WxPayMicropayResult micropay(WxPayMicropayRequest request)
                      throws WxPayException

 提交付款码支付.
 文档地址：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 - the request

返回:

the wx pay micropay result

抛出:

WxPayException - the wx pay exception

reverseOrder

WxPayOrderReverseResult reverseOrder(WxPayOrderReverseRequest request)
                              throws WxPayException

 撤销订单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 - the request

返回:

the wx pay order reverse result

抛出:

WxPayException - the wx pay exception

shorturl

String shorturl(WxPayShorturlRequest request)
         throws WxPayException

  转换短链接.
  文档地址：
     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
  是否需要证书：否
 

参数:

request - 请求对象

返回:

the string

抛出:

WxPayException - the wx pay exception

shorturl

String shorturl(String longUrl)
         throws WxPayException

  转换短链接.
 

参数:

longUrl - 需要被压缩的网址

返回:

the string

抛出:

WxPayException - the wx pay exception

另请参阅:

WxPayService#shorturl(WxPayShorturlRequest)WxPayService#shorturl(WxPayShorturlRequest)

authcode2Openid

String authcode2Openid(WxPayAuthcode2OpenidRequest request)
                throws WxPayException

 授权码查询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
 

参数:

request - 请求对象

返回:

openid string

抛出:

WxPayException - the wx pay exception

authcode2Openid

String authcode2Openid(String authCode)
                throws WxPayException

 授权码查询OPENID接口.
 

参数:

authCode - 授权码

返回:

openid string

抛出:

WxPayException - the wx pay exception

另请参阅:

WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest)WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest)

getSandboxSignKey

String getSandboxSignKey()
                  throws WxPayException

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

返回:

the sandbox sign key

抛出:

WxPayException - the wx pay exception

sendCoupon

WxPayCouponSendResult sendCoupon(WxPayCouponSendRequest request)
                          throws WxPayException

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

参数:

request - the request

返回:

the wx pay coupon send result

抛出:

WxPayException - the wx pay exception

queryCouponStock

WxPayCouponStockQueryResult queryCouponStock(WxPayCouponStockQueryRequest request)
                                      throws WxPayException

 查询代金券批次.
 接口请求链接：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
 

参数:

request - the request

返回:

the wx pay coupon stock query result

抛出:

WxPayException - the wx pay exception

queryCouponInfo

WxPayCouponInfoQueryResult queryCouponInfo(WxPayCouponInfoQueryRequest request)
                                    throws WxPayException

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

参数:

request - the request

返回:

the wx pay coupon info query result

抛出:

WxPayException - the wx pay exception

getWxApiData

WxPayApiData getWxApiData()

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

返回:

the wx api data

queryComment

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

 拉取订单评价数据.
 商户可以通过该接口拉取用户在微信支付交易记录中针对你的支付记录进行的评价内容。商户可结合商户系统逻辑对该内容数据进行存储、分析、展示、客服回访以及其他使用。如商户业务对评价内容有依赖，可主动引导用户进入微信支付交易记录进行评价。
 注意：
 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
 

参数:

beginDate - 开始时间

endDate - 结束时间

offset - 位移

limit - 条数，建议填null，否则接口会报签名错误

返回:

the string

抛出:

WxPayException - the wx pay exception

queryComment

String queryComment(WxPayQueryCommentRequest request)
             throws WxPayException

 拉取订单评价数据.
 商户可以通过该接口拉取用户在微信支付交易记录中针对你的支付记录进行的评价内容。商户可结合商户系统逻辑对该内容数据进行存储、分析、展示、客服回访以及其他使用。如商户业务对评价内容有依赖，可主动引导用户进入微信支付交易记录进行评价。
 注意：
 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
 

参数:

request - 查询请求

返回:

the string

抛出:

WxPayException - the wx pay exception

getWxPayFaceAuthInfo

WxPayFaceAuthInfoResult getWxPayFaceAuthInfo(WxPayFaceAuthInfoRequest request)
                                      throws WxPayException

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

参数:

request - the request

返回:

the wx pay get face authinfo result

抛出:

WxPayException - the wx pay exception

facepay

WxPayFacepayResult facepay(WxPayFacepayRequest request)
                    throws WxPayException

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

参数:

request - the request

返回:

the wx pay facepay result

抛出:

WxPayException - the wx pay exception

queryExchangeRate

WxPayQueryExchangeRateResult queryExchangeRate(String feeType,
                                               String date)
                                        throws WxPayException

查询汇率

 应用场景：商户网站的商品以外币标价时，通过该接口可以实时查询到微信使用的转换汇率。汇率更新时间为北京时间上午10:00，一天更新一次。
 文档地址：https://pay.weixin.qq.com/wiki/doc/api/app/app_jw.php?chapter=9_15&index=12
 接口链接：https://api.mch.weixin.qq.com/pay/queryexchagerate
 

参数:

feeType - 外币币种

date - 日期，格式为yyyyMMdd，如2009年12月25日表示为20091225。时区为GMT+8 beijing

返回:

. wx pay query exchange rate result

抛出:

WxPayException - .