WxPayService (pay-java-wx 2.14.3 API)

java.lang.Object
- com.egzosn.pay.common.api.BasePayService<WxPayConfigStorage>
- - com.egzosn.pay.wx.api.WxPayService

所有已实现的接口:: PayService<WxPayConfigStorage>, WxBillService, WxRedPackService

public class WxPayService
extends BasePayService<WxPayConfigStorage>
implements WxRedPackService, WxBillService

微信支付服务

作者:

egan

 email egzosn@gmail.com
 date 2016-5-18 14:09:01

字段概要
- 从类继承的字段 com.egzosn.pay.common.api.BasePayService
  handler, interceptors, LOG, maxRetryTimes, payConfigStorage, requestTemplate, retrySleepMillis

构造器概要

构造器
构造器和说明
`WxPayService(WxPayConfigStorage payConfigStorage)` 创建支付服务
`WxPayService(WxPayConfigStorage payConfigStorage, HttpConfigStorage configStorage)` 创建支付服务

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`String`	`buildRequest(Map<String,Object> orderInfo, MethodType method)` 获取输出消息，用户返回给支付端, 针对于web端
`Map<String,Object>`	`cancel(String transactionId, String outTradeNo)` 交易交易撤销
`Map<String,Object>`	`close(String transactionId, String outTradeNo)` 交易关闭接口
`PayMessage`	`createMessage(Map<String,Object> message)` 创建消息
`String`	`createSign(String content, String characterEncoding)` 签名
`String`	`createSign(String content, String characterEncoding, boolean test)` 签名
`Map<String,Object>`	`downloadBill(Date billDate, BillType billType)` 目前只支持日账单
`Map<String,Object>`	`downloadbill(Date billDate, String billType)` 已过时。
`Map<String,Object>`	`downloadbill(Date billDate, String billType, String path)` 已过时。
`Map<String,Object>`	`gethbinfo(String mchBillno)` 查询红包记录用于商户对已发放的红包进行查询红包的具体信息，可支持普通红包和裂变包查询红包记录API只支持查询30天内的红包订单，30天之前的红包订单请登录商户平台查询。
`Map<String,Object>`	`getParameter2Map(Map<String,String[]> parameterMap, InputStream is)` 将请求参数或者请求流转化为 Map
`PayOutMessage`	`getPayOutMessage(String code, String message)` 获取输出消息，用户返回给支付端
`String`	`getQrPay(PayOrder order)` 获取输出二维码信息,
`String`	`getReqUrl(TransactionType transactionType)` 根据交易类型获取url
`String`	`keyPublic(String content)`
`Map<String,Object>`	`microPay(PayOrder order)` 刷卡付,pos主动扫码付款
`Map<String,Object>`	`orderInfo(PayOrder order)` 返回创建的订单信息
`Map<String,Object>`	`payBank(Map<String,Object> parameters, TransferOrder order)` 转账到银行卡所需要参数
`Map<String,Object>`	`query(String transactionId, String outTradeNo)` 交易查询接口
`WxRefundResult`	`refund(RefundOrder refundOrder)` 申请退款接口
`Map<String,Object>`	`refundquery(RefundOrder refundOrder)` 查询退款
`Map<String,Object>`	`secondaryInterface(Object transactionIdOrBillDate, String outTradeNoBillType, TransactionType transactionType)`
`Map<String,Object>`	`sendredpack(RedpackOrder redpackOrder)` 微信发红包
`BasePayService`	`setPayConfigStorage(WxPayConfigStorage payConfigStorage)` 设置支付配置
`boolean`	`signVerify(Map<String,Object> params, String sign)` 根据反馈回来的信息，生成签名结果
`PayOutMessage`	`successPayOutMessage(PayMessage payMessage)` 获取成功输出消息，用户返回给支付端主要用于拦截器中返回
`Map<String,Object>`	`transfer(TransferOrder order)` 转账
`Map<String,Object>`	`transferQuery(String outNo, String wxTransferType)` 转账查询
`Map<String,Object>`	`transfers(Map<String,Object> parameters, TransferOrder order)` 转账到余额所需要参数
`static InputStream`	`uncompress(InputStream input)` 已过时。
`com.alibaba.fastjson.JSONObject`	`unifiedOrder(PayOrder order)` 微信统一下单接口
`boolean`	`verify(Map<String,Object> params)` 回调校验

从类继承的方法 com.egzosn.pay.common.api.BasePayService
addPayMessageInterceptor, app, authorizationString, cancel, close, createSign, downloadbill, genQrPay, getHttpRequestTemplate, getPayConfigStorage, getPayMessageHandler, payBack, payBack, preOrderHandler, query, refund, refundquery, setParameters, setParameters, setPayMessageHandler, setRequestTemplateConfigStorage, toPay, transfer, transferQuery

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

- 构造器详细资料
  - WxPayService
```
public WxPayService(WxPayConfigStorage payConfigStorage)
```
    创建支付服务
    
    参数:
    
    payConfigStorage - 微信对应的支付配置
  - WxPayService
```
public WxPayService(WxPayConfigStorage payConfigStorage,
                    HttpConfigStorage configStorage)
```
    创建支付服务
    
    参数:
    
    payConfigStorage - 微信对应的支付配置
    
    configStorage - 微信对应的网络配置，包含代理配置、ssl证书配置
- 方法详细资料
  - setPayConfigStorage
```
public BasePayService setPayConfigStorage(WxPayConfigStorage payConfigStorage)
```
    设置支付配置
    
    指定者:
    
    setPayConfigStorage 在接口中 PayService<WxPayConfigStorage>
    
    覆盖:
    
    setPayConfigStorage 在类中 BasePayService<WxPayConfigStorage>
    
    参数:
    
    payConfigStorage - 支付配置
  - getReqUrl
```
public String getReqUrl(TransactionType transactionType)
```
    根据交易类型获取url
    
    指定者:
    
    getReqUrl 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    transactionType - 交易类型
    
    返回:
    
    请求url
  - verify
```
public boolean verify(Map<String,Object> params)
```
    回调校验
    
    指定者:
    
    verify 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    params - 回调回来的参数集
    
    返回:
    
    签名校验 true通过
  - signVerify
```
public boolean signVerify(Map<String,Object> params,
                          String sign)
```
    根据反馈回来的信息，生成签名结果
    
    参数:
    
    params - 通知返回来的参数数组
    
    sign - 比对的签名结果
    
    返回:
    
    生成的签名结果
  - unifiedOrder
```
public com.alibaba.fastjson.JSONObject unifiedOrder(PayOrder order)
```
    微信统一下单接口
    
    参数:
    
    order - 支付订单集
    
    返回:
    
    下单结果
  - orderInfo
```
public Map<String,Object> orderInfo(PayOrder order)
```
    返回创建的订单信息
    
    指定者:
    
    orderInfo 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    order - 支付订单
    
    返回:
    
    订单信息
    
    另请参阅:
    
    支付订单信息
  - createSign
```
public String createSign(String content,
                         String characterEncoding)
```
    签名
    
    指定者:
    
    createSign 在接口中 PayService<WxPayConfigStorage>
    
    覆盖:
    
    createSign 在类中 BasePayService<WxPayConfigStorage>
    
    参数:
    
    content - 需要签名的内容不包含key
    
    characterEncoding - 字符编码
    
    返回:
    
    签名结果
  - createSign
```
public String createSign(String content,
                         String characterEncoding,
                         boolean test)
```
    签名
    
    参数:
    
    content - 需要签名的内容不包含key
    
    characterEncoding - 字符编码
    
    test - 是否为沙箱环境
    
    返回:
    
    签名结果
  - getParameter2Map
```
public Map<String,Object> getParameter2Map(Map<String,String[]> parameterMap,
                                           InputStream is)
```
    将请求参数或者请求流转化为 Map
    
    指定者:
    
    getParameter2Map 在接口中 PayService<WxPayConfigStorage>
    
    覆盖:
    
    getParameter2Map 在类中 BasePayService<WxPayConfigStorage>
    
    参数:
    
    parameterMap - 请求参数
    
    is - 请求流
    
    返回:
    
    获得回调的请求参数
  - getPayOutMessage
```
public PayOutMessage getPayOutMessage(String code,
                                      String message)
```
    获取输出消息，用户返回给支付端
    
    指定者:
    
    getPayOutMessage 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    code - 状态
    
    message - 消息
    
    返回:
    
    返回输出消息
  - successPayOutMessage
```
public PayOutMessage successPayOutMessage(PayMessage payMessage)
```
    获取成功输出消息，用户返回给支付端主要用于拦截器中返回
    
    指定者:
    
    successPayOutMessage 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    payMessage - 支付回调消息
    
    返回:
    
    返回输出消息
  - buildRequest
```
public String buildRequest(Map<String,Object> orderInfo,
                           MethodType method)
```
    获取输出消息，用户返回给支付端, 针对于web端
    
    指定者:
    
    buildRequest 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    orderInfo - 发起支付的订单信息
    
    method - 请求方式 "post" "get",
    
    返回:
    
    获取输出消息，用户返回给支付端, 针对于web端
    
    另请参阅:
    
    请求类型
  - getQrPay
```
public String getQrPay(PayOrder order)
```
    获取输出二维码信息,
    
    指定者:
    
    getQrPay 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    order - 发起支付的订单信息
    
    返回:
    
    返回二维码信息,，支付时需要的
  - microPay
```
public Map<String,Object> microPay(PayOrder order)
```
    刷卡付,pos主动扫码付款
    
    指定者:
    
    microPay 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    order - 发起支付的订单信息
    
    返回:
    
    返回支付结果
  - query
```
public Map<String,Object> query(String transactionId,
                                String outTradeNo)
```
    交易查询接口
    
    指定者:
    
    query 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    transactionId - 微信支付平台订单号
    
    outTradeNo - 商户单号
    
    返回:
    
    返回查询回来的结果集，支付方原值返回
  - close
```
public Map<String,Object> close(String transactionId,
                                String outTradeNo)
```
    交易关闭接口
    
    指定者:
    
    close 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    transactionId - 支付平台订单号
    
    outTradeNo - 商户单号
    
    返回:
    
    返回支付方交易关闭后的结果
  - cancel
```
public Map<String,Object> cancel(String transactionId,
                                 String outTradeNo)
```
    交易交易撤销
    
    指定者:
    
    cancel 在接口中 PayService<WxPayConfigStorage>
    
    覆盖:
    
    cancel 在类中 BasePayService<WxPayConfigStorage>
    
    参数:
    
    transactionId - 支付平台订单号
    
    outTradeNo - 商户单号
    
    返回:
    
    返回支付方交易撤销后的结果
  - refund
```
public WxRefundResult refund(RefundOrder refundOrder)
```
    申请退款接口
    
    指定者:
    
    refund 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    refundOrder - 退款订单信息
    
    返回:
    
    返回支付方申请退款后的结果
  - refundquery
```
public Map<String,Object> refundquery(RefundOrder refundOrder)
```
    查询退款
    
    指定者:
    
    refundquery 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    refundOrder - 退款订单单号信息
    
    返回:
    
    返回支付方查询退款后的结果
  - downloadbill
```
@Deprecated
public Map<String,Object> downloadbill(Date billDate,
                                                    String billType)
```
    已过时。
    
    目前只支持日账单
    
    指定者:
    
    downloadbill 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    billDate - 下载对账单的日期，格式：20140603
    
    billType - 账单类型 ALL（默认值），返回当日所有订单信息（不含充值退款订单） SUCCESS，返回当日成功支付的订单（不含充值退款订单） REFUND，返回当日退款订单（不含充值退款订单） RECHARGE_REFUND，返回当日充值退款订单
    
    返回:
    
    返回支付方下载对账单的结果
  - downloadBill
```
public Map<String,Object> downloadBill(Date billDate,
                                       BillType billType)
```
    目前只支持日账单
    
    指定者:
    
    downloadBill 在接口中 PayService<WxPayConfigStorage>
    
    参数:
    
    billDate - 下载对账单的日期，格式：20140603
    
    billType - 账单类型 ALL（默认值），返回当日所有订单信息（不含充值退款订单） SUCCESS，返回当日成功支付的订单（不含充值退款订单） REFUND，返回当日退款订单（不含充值退款订单） RECHARGE_REFUND，返回当日充值退款订单
    
    返回:
    
    返回支付方下载对账单的结果, 如果【账单类型】为gzip的话则返回值中key为data值为gzip的输入流
  - downloadbill
```
@Deprecated
public Map<String,Object> downloadbill(Date billDate,
                                                    String billType,
                                                    String path)
```
    已过时。
    
    目前只支持日账单,增加账单返回格式
    
    指定者:
    
    downloadbill 在接口中 WxBillService
    
    参数:
    
    billDate - 账单类型，商户通过接口或商户经开放平台授权后其所属服务商通过接口可以获取以下账单类型：trade、signcustomer；trade指商户基于支付宝交易收单的业务账单；signcustomer是指基于商户支付宝余额收入及支出等资金变动的帐务账单；
    
    billType - 账单时间：日账单格式为yyyy-MM-dd，月账单格式为yyyy-MM。
    
    path - 账单返回格式账单存储的基础路径,按月切割
    
    返回:
    
    返回支付方下载对账单的结果
  - uncompress
```
@Deprecated
public static InputStream uncompress(InputStream input)
                                           throws IOException
```
    已过时。
    
    GZIP解压缩
    
    参数:
    
    input - 输入流账单
    
    返回:
    
    解压后输入流
    
    抛出:
    
    IOException - IOException
  - secondaryInterface
```
public Map<String,Object> secondaryInterface(Object transactionIdOrBillDate,
                                             String outTradeNoBillType,
                                             TransactionType transactionType)
```
    参数:
    
    transactionIdOrBillDate - 支付平台订单号或者账单日期，具体请类型为String或者 Date，类型须强制限制，类型不对应则抛出异常PayErrorException
    
    outTradeNoBillType - 商户单号或者账单类型
    
    transactionType - 交易类型
    
    返回:
    
    返回支付方对应接口的结果
  - transfer
```
public Map<String,Object> transfer(TransferOrder order)
```
    转账
    指定者:
    
    transfer 在接口中 PayService<WxPayConfigStorage>
    
    覆盖:
    
    transfer 在类中 BasePayService<WxPayConfigStorage>
    
    参数:
    order - 转账订单
    注意事项： ◆ 当返回错误码为“SYSTEMERROR”时，请不要更换商户订单号，一定要使用原商户订单号重试，否则可能造成重复支付等资金风险。 ◆ XML具有可扩展性，因此返回参数可能会有新增，而且顺序可能不完全遵循此文档规范，如果在解析回包的时候发生错误，请商户务必不要换单重试，请商户联系客服确认付款情况。如果有新回包字段，会更新到此API文档中。 ◆ 因为错误代码字段err_code的值后续可能会增加，所以商户如果遇到回包返回新的错误码，请商户务必不要换单重试，请商户联系客服确认付款情况。如果有新的错误码，会更新到此API文档中。 ◆ 错误代码描述字段err_code_des只供人工定位问题时做参考，系统实现时请不要依赖这个字段来做自动化处理。
    返回:
    
    对应的转账结果
  - transfers
```
public Map<String,Object> transfers(Map<String,Object> parameters,
                                    TransferOrder order)
```
    转账到余额所需要参数
    
    参数:
    
    parameters - 参数信息
    
    order - 转账订单
    
    返回:
    
    包装后参数信息
    企业付款到零钱商户企业付款到银行卡
  - payBank
```
public Map<String,Object> payBank(Map<String,Object> parameters,
                                  TransferOrder order)
```
    转账到银行卡所需要参数
    
    参数:
    
    parameters - 参数信息
    
    order - 转账订单
    
    返回:
    
    包装后参数信息
  - transferQuery
```
public Map<String,Object> transferQuery(String outNo,
                                        String wxTransferType)
```
    转账查询
    
    指定者:
    
    transferQuery 在接口中 PayService<WxPayConfigStorage>
    
    覆盖:
    
    transferQuery 在类中 BasePayService<WxPayConfigStorage>
    
    参数:
    
    outNo - 商户转账订单号
    
    wxTransferType - 微信转账类型，.....这里没办法了只能这样写(┬＿┬)，请见谅 WxTransferType
    企业付款到零钱商户企业付款到银行卡
    
    返回:
    
    对应的转账订单
  - keyPublic
```
public String keyPublic(String content)
```
  - createMessage
```
public PayMessage createMessage(Map<String,Object> message)
```
    创建消息
    
    指定者:
    
    createMessage 在接口中 PayService<WxPayConfigStorage>
    
    覆盖:
    
    createMessage 在类中 BasePayService<WxPayConfigStorage>
    
    参数:
    
    message - 支付平台返回的消息
    
    返回:
    
    支付消息对象
  - sendredpack
```
public Map<String,Object> sendredpack(RedpackOrder redpackOrder)
```
    微信发红包
    
    指定者:
    
    sendredpack 在接口中 WxRedPackService
    
    参数:
    
    redpackOrder - 红包实体
    
    返回:
    
    返回发红包实体后的结果
  - gethbinfo
```
public Map<String,Object> gethbinfo(String mchBillno)
```
    查询红包记录用于商户对已发放的红包进行查询红包的具体信息，可支持普通红包和裂变包查询红包记录API只支持查询30天内的红包订单，30天之前的红包订单请登录商户平台查询。
    
    指定者:
    
    gethbinfo 在接口中 WxRedPackService
    
    参数:
    
    mchBillno - 商户发放红包的商户订单号
    
    返回:
    
    返回查询结果

类 WxPayService

字段概要

从类继承的字段 com.egzosn.pay.common.api.BasePayService

构造器概要

方法概要

从类继承的方法 com.egzosn.pay.common.api.BasePayService

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

构造器详细资料

WxPayService

WxPayService

方法详细资料

setPayConfigStorage

getReqUrl

verify

signVerify

unifiedOrder

orderInfo

createSign

createSign

getParameter2Map

getPayOutMessage

successPayOutMessage

buildRequest

getQrPay

microPay

query

close

cancel

refund

refundquery

downloadbill

downloadBill

downloadbill

uncompress

secondaryInterface

transfer

transfers

payBank

transferQuery

keyPublic

createMessage

sendredpack

gethbinfo