WxPayServiceImpl (wechat 0.0.1 API)

java.lang.Object
- com.bookrain.wechat.pay.service.impl.WxPayServiceImpl

所有已实现的接口:

WxPayService
```
@Service
public class WxPayServiceImpl
extends Object
implements WxPayService
```
.

版本:

1.0

作者:

Bookrain Chu

时间

2019-07-25 14:37

构造器概要

构造器
构造器和说明

WxPayServiceImpl(WeChatProperties weChatProperties, WxPayRestTemplateBuilder wxPayRestTemplateBuilder)

构造器
构造器和说明
`WxPayServiceImpl(WeChatProperties weChatProperties, WxPayRestTemplateBuilder wxPayRestTemplateBuilder)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Map<String,String>`	`authCodeToOpenid(WxPayAuthCodeToOpenIdRequest authCodeToOpenIdRequest)` 作用：授权码查询OPENID接口场景：刷卡支付
`Map<String,String>`	`authCodeToOpenid(WxPayAuthCodeToOpenIdRequest authCodeToOpenIdRequest, int timeout)` 作用：授权码查询OPENID接口场景：刷卡支付
`Map<String,String>`	`closeOrder(WxPayCloseOrderRequest closeOrderRequest)` 作用：关闭订单场景：公共号支付、扫码支付、APP支付
`Map<String,String>`	`closeOrder(WxPayCloseOrderRequest closeOrderRequest, int timeout)` 作用：关闭订单场景：公共号支付、扫码支付、APP支付
`Map<String,String>`	`downloadBill(WxPayDownloadBillRequest downloadBillRequest)` 作用：对账单下载（成功时返回对账单数据，失败时返回XML格式数据）场景：刷卡支付、公共号支付、扫码支付、APP支付
`Map<String,String>`	`downloadBill(WxPayDownloadBillRequest downloadBillRequest, int timeout)` 作用：对账单下载场景：刷卡支付、公共号支付、扫码支付、APP支付其他：无论是否成功都返回Map。
`Map<String,String>`	`fillRequestData(Map<String,String> reqData)` 向 Map 中添加 appid、mch_id、nonce_str、sign_type、sign 该函数适用于商户适用于统一下单等接口，不适用于红包、代金券接口
`boolean`	`isResponseSignatureValid(Map<String,String> reqData)` 判断xml数据的sign是否有效，必须包含sign字段，否则返回false。
`Map<String,String>`	`microPay(WxPayMicroPayRequest microPayRequest)` 作用：提交刷卡支付场景：刷卡支付
`Map<String,String>`	`microPay(WxPayMicroPayRequest microPayRequest, int timeout)` 作用：提交刷卡支付场景：刷卡支付
`Map<String,String>`	`orderQuery(WXPayOrderQueryRequest orderQueryRequest)` 作用：查询订单场景：刷卡支付、公共号支付、扫码支付、APP支付
`Map<String,String>`	`orderQuery(WXPayOrderQueryRequest orderQueryRequest, int timeout)` 作用：查询订单场景：刷卡支付、公共号支付、扫码支付、APP支付
`Map<String,String>`	`processResponseXml(String xmlStr)` 处理 HTTPS API返回数据，转换成Map对象。
`Map<String,String>`	`refund(WxPayRefundRequest refundRequest)` 作用：申请退款场景：刷卡支付、公共号支付、扫码支付、APP支付
`Map<String,String>`	`refund(WxPayRefundRequest refundRequest, int timeout)` 作用：申请退款场景：刷卡支付、公共号支付、扫码支付、APP支付其他：需要证书
`Map<String,String>`	`refundQuery(WxPayRefundQueryRequest refundQueryRequest)` 作用：退款查询场景：刷卡支付、公共号支付、扫码支付、APP支付
`Map<String,String>`	`refundQuery(WxPayRefundQueryRequest refundQueryRequest, int timeout)` 作用：退款查询场景：刷卡支付、公共号支付、扫码支付、APP支付
`Map<String,String>`	`report(WxPayReportRequest reportRequest)` 作用：交易保障场景：刷卡支付、公共号支付、扫码支付、APP支付
`Map<String,String>`	`report(WxPayReportRequest reportRequest, int timeout)` 作用：交易保障场景：刷卡支付、公共号支付、扫码支付、APP支付
`Map<String,String>`	`reverse(WxPayReverseRequest payReverseRequest)` 作用：撤销订单场景：刷卡支付
`Map<String,String>`	`reverse(WxPayReverseRequest payReverseRequest, int timeout)` 作用：撤销订单场景：刷卡支付其他：需要证书
`Map<String,String>`	`shortUrl(WxPayShortUrlRequest shortUrlRequest)` 作用：转换短链接场景：刷卡支付、扫码支付
`Map<String,String>`	`shortUrl(WxPayShortUrlRequest shortUrlRequest, int timeout)` 作用：转换短链接场景：刷卡支付、扫码支付
`Map<String,String>`	`unifiedOrder(WxPayUnifiedOrderRequest unifiedOrderRequest)` 作用：统一下单场景：公共号支付、扫码支付、APP支付
`Map<String,String>`	`unifiedOrder(WxPayUnifiedOrderRequest unifiedOrderRequest, int timeout)` 作用：统一下单场景：公共号支付、扫码支付、APP支付

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

- 构造器详细资料
  - WxPayServiceImpl
```
public WxPayServiceImpl(WeChatProperties weChatProperties,
                        WxPayRestTemplateBuilder wxPayRestTemplateBuilder)
```
- 方法详细资料
  - microPay
```
public Map<String,String> microPay(WxPayMicroPayRequest microPayRequest)
                            throws Exception
```
    作用：提交刷卡支付
    场景：刷卡支付
    
    指定者:
    
    microPay 在接口中 WxPayService
    
    参数:
    
    microPayRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - microPay
```
public Map<String,String> microPay(WxPayMicroPayRequest microPayRequest,
                                   int timeout)
                            throws Exception
```
    作用：提交刷卡支付
    场景：刷卡支付
    
    指定者:
    
    microPay 在接口中 WxPayService
    
    参数:
    
    microPayRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - unifiedOrder
```
public Map<String,String> unifiedOrder(WxPayUnifiedOrderRequest unifiedOrderRequest)
                                throws Exception
```
    作用：统一下单
    场景：公共号支付、扫码支付、APP支付
    
    指定者:
    
    unifiedOrder 在接口中 WxPayService
    
    参数:
    
    unifiedOrderRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - unifiedOrder
```
public Map<String,String> unifiedOrder(WxPayUnifiedOrderRequest unifiedOrderRequest,
                                       int timeout)
                                throws Exception
```
    作用：统一下单
    场景：公共号支付、扫码支付、APP支付
    
    指定者:
    
    unifiedOrder 在接口中 WxPayService
    
    参数:
    
    unifiedOrderRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - orderQuery
```
public Map<String,String> orderQuery(WXPayOrderQueryRequest orderQueryRequest)
                              throws Exception
```
    作用：查询订单
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    
    指定者:
    
    orderQuery 在接口中 WxPayService
    
    参数:
    
    orderQueryRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - orderQuery
```
public Map<String,String> orderQuery(WXPayOrderQueryRequest orderQueryRequest,
                                     int timeout)
                              throws Exception
```
    作用：查询订单
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    
    指定者:
    
    orderQuery 在接口中 WxPayService
    
    参数:
    
    orderQueryRequest - 向wxpay post的请求数据 int
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - reverse
```
public Map<String,String> reverse(WxPayReverseRequest payReverseRequest)
                           throws Exception
```
    作用：撤销订单
    场景：刷卡支付
    
    指定者:
    
    reverse 在接口中 WxPayService
    
    参数:
    
    payReverseRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - reverse
```
public Map<String,String> reverse(WxPayReverseRequest payReverseRequest,
                                  int timeout)
                           throws Exception
```
    作用：撤销订单
    场景：刷卡支付
    其他：需要证书
    
    指定者:
    
    reverse 在接口中 WxPayService
    
    参数:
    
    payReverseRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - closeOrder
```
public Map<String,String> closeOrder(WxPayCloseOrderRequest closeOrderRequest)
                              throws Exception
```
    作用：关闭订单
    场景：公共号支付、扫码支付、APP支付
    
    指定者:
    
    closeOrder 在接口中 WxPayService
    
    参数:
    
    closeOrderRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - closeOrder
```
public Map<String,String> closeOrder(WxPayCloseOrderRequest closeOrderRequest,
                                     int timeout)
                              throws Exception
```
    作用：关闭订单
    场景：公共号支付、扫码支付、APP支付
    
    指定者:
    
    closeOrder 在接口中 WxPayService
    
    参数:
    
    closeOrderRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - refund
```
public Map<String,String> refund(WxPayRefundRequest refundRequest)
                          throws Exception
```
    作用：申请退款
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    
    指定者:
    
    refund 在接口中 WxPayService
    
    参数:
    
    refundRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - refund
```
public Map<String,String> refund(WxPayRefundRequest refundRequest,
                                 int timeout)
                          throws Exception
```
    作用：申请退款
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    其他：需要证书
    
    指定者:
    
    refund 在接口中 WxPayService
    
    参数:
    
    refundRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - refundQuery
```
public Map<String,String> refundQuery(WxPayRefundQueryRequest refundQueryRequest)
                               throws Exception
```
    作用：退款查询
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    
    指定者:
    
    refundQuery 在接口中 WxPayService
    
    参数:
    
    refundQueryRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - refundQuery
```
public Map<String,String> refundQuery(WxPayRefundQueryRequest refundQueryRequest,
                                      int timeout)
                               throws Exception
```
    作用：退款查询
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    
    指定者:
    
    refundQuery 在接口中 WxPayService
    
    参数:
    
    refundQueryRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - downloadBill
```
public Map<String,String> downloadBill(WxPayDownloadBillRequest downloadBillRequest)
                                throws Exception
```
    作用：对账单下载（成功时返回对账单数据，失败时返回XML格式数据）
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    
    指定者:
    
    downloadBill 在接口中 WxPayService
    
    参数:
    
    downloadBillRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - downloadBill
```
public Map<String,String> downloadBill(WxPayDownloadBillRequest downloadBillRequest,
                                       int timeout)
                                throws Exception
```
    作用：对账单下载
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    其他：无论是否成功都返回Map。若成功，返回的Map中含有return_code、return_msg、data，其中return_code为`SUCCESS`，data为对账单数据。
    
    指定者:
    
    downloadBill 在接口中 WxPayService
    
    参数:
    
    downloadBillRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    经过封装的API返回数据
    
    抛出:
    
    Exception - 异常
  - report
```
public Map<String,String> report(WxPayReportRequest reportRequest)
                          throws Exception
```
    作用：交易保障
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    
    指定者:
    
    report 在接口中 WxPayService
    
    参数:
    
    reportRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - report
```
public Map<String,String> report(WxPayReportRequest reportRequest,
                                 int timeout)
                          throws Exception
```
    作用：交易保障
    场景：刷卡支付、公共号支付、扫码支付、APP支付
    
    指定者:
    
    report 在接口中 WxPayService
    
    参数:
    
    reportRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - shortUrl
```
public Map<String,String> shortUrl(WxPayShortUrlRequest shortUrlRequest)
                            throws Exception
```
    作用：转换短链接
    场景：刷卡支付、扫码支付
    
    指定者:
    
    shortUrl 在接口中 WxPayService
    
    参数:
    
    shortUrlRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - shortUrl
```
public Map<String,String> shortUrl(WxPayShortUrlRequest shortUrlRequest,
                                   int timeout)
                            throws Exception
```
    作用：转换短链接
    场景：刷卡支付、扫码支付
    
    指定者:
    
    shortUrl 在接口中 WxPayService
    
    参数:
    
    shortUrlRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - authCodeToOpenid
```
public Map<String,String> authCodeToOpenid(WxPayAuthCodeToOpenIdRequest authCodeToOpenIdRequest)
                                    throws Exception
```
    作用：授权码查询OPENID接口
    场景：刷卡支付
    
    指定者:
    
    authCodeToOpenid 在接口中 WxPayService
    
    参数:
    
    authCodeToOpenIdRequest - 向wxpay post的请求数据
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - authCodeToOpenid
```
public Map<String,String> authCodeToOpenid(WxPayAuthCodeToOpenIdRequest authCodeToOpenIdRequest,
                                           int timeout)
                                    throws Exception
```
    作用：授权码查询OPENID接口
    场景：刷卡支付
    
    指定者:
    
    authCodeToOpenid 在接口中 WxPayService
    
    参数:
    
    authCodeToOpenIdRequest - 向wxpay post的请求数据
    
    timeout - 超时时间
    
    返回:
    
    API返回数据
    
    抛出:
    
    Exception - 异常
  - fillRequestData
```
public Map<String,String> fillRequestData(Map<String,String> reqData)
                                   throws Exception
```
    向 Map 中添加 appid、mch_id、nonce_str、sign_type、sign
    该函数适用于商户适用于统一下单等接口，不适用于红包、代金券接口
    
    参数:
    
    reqData - 请求数据
    
    返回:
    
    转换后的数据
    
    抛出:
    
    Exception - 异常
  - processResponseXml
```
public Map<String,String> processResponseXml(String xmlStr)
                                      throws Exception
```
    处理 HTTPS API返回数据，转换成Map对象。return_code为SUCCESS时，验证签名。
    
    参数:
    
    xmlStr - API返回的XML格式数据
    
    返回:
    
    Map类型数据
    
    抛出:
    
    Exception - 异常
  - isResponseSignatureValid
```
public boolean isResponseSignatureValid(Map<String,String> reqData)
                                 throws Exception
```
    判断xml数据的sign是否有效，必须包含sign字段，否则返回false。
    
    参数:
    
    reqData - 向wxpay post的请求数据
    
    返回:
    
    签名是否有效
    
    抛出:
    
    Exception - 异常

类 WxPayServiceImpl

构造器概要

方法概要

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

构造器详细资料

WxPayServiceImpl

方法详细资料

microPay

microPay

unifiedOrder

unifiedOrder

orderQuery

orderQuery

reverse

reverse

closeOrder

closeOrder

refund

refund

refundQuery

refundQuery

downloadBill

downloadBill

report

report

shortUrl

shortUrl

authCodeToOpenid

authCodeToOpenid

fillRequestData

processResponseXml

isResponseSignatureValid