diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java index 3f98c3d2c..5afabbb3d 100644 --- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java @@ -35,17 +35,17 @@ public interface WxPayService { String getPayBaseUrl(); /** - * Map里 加入新的 {@link WxPayConfig}，适用于动态添加新的微信公众号配置. + * Map里 加入新的 {@link WxPayConfig}，适用于动态添加新的微信商户配置. * - * @param mchId 商户号id + * @param mchId 商户id * @param wxPayConfig 新的微信配置 */ void addConfig(String mchId, WxPayConfig wxPayConfig); /** - * 从 Map中 移除 {@link String mchId} 所对应的 {@link WxPayConfig}，适用于动态移除微信公众号配置. + * 从 Map中 移除 {@link String mchId} 所对应的 {@link WxPayConfig}，适用于动态移除微信商户配置. * - * @param mchId 对应公众号的标识 + * @param mchId 对应商户的标识 */ void removeConfig(String mchId); @@ -66,17 +66,17 @@ public interface WxPayService { void setMultiConfig(Map wxPayConfigs, String defaultMchId); /** - * 进行相应的公众号切换. + * 进行相应的商户切换. * - * @param mchId 公众号标识 + * @param mchId 商户标识 * @return 切换是否成功 boolean */ boolean switchover(String mchId); /** - * 进行相应的公众号切换. + * 进行相应的商户切换. * - * @param mchId 公众号标识 + * @param mchId 商户标识 * @return 切换成功 ，则返回当前对象，方便链式调用，否则抛出异常 */ WxPayService switchoverTo(String mchId); @@ -176,8 +176,8 @@ public interface WxPayService { /** * 发送put V3请求，得到响应字符串. * - * @param url 请求地址 - * @param url 请求数据 + * @param url 请求地址 + * @param requestStr 请求数据 * @return 返回请求结果字符串 string * @throws WxPayException the wx pay exception */ @@ -194,6 +194,7 @@ public interface WxPayService { /** * 获取微信签约代扣服务类 + * * @return entrust service */ WxEntrustPapService getWxEntrustPapService(); @@ -229,7 +230,7 @@ public interface WxPayService { /** * 获取分账服务类. *

- * V3接口 {@link WxPayService#getProfitSharingV3Service()} + * V3接口 {@link WxPayService#getProfitSharingV3Service()} *

* * @return the ent pay service @@ -341,7 +342,7 @@ public interface WxPayService { /** * 
    * 查询订单
-   * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml
+   * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml
    * 商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。查询订单状态可通过微信支付订单号或商户订单号两种方式查询
    * 注意：
    *  查询订单可通过微信支付订单号和商户订单号两种方式查询，两种查询方式返回结果相同
@@ -365,7 +366,7 @@ public interface WxPayService {
   /**
    * 
    * 查询订单
-   * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml
+   * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml
    * 商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。查询订单状态可通过微信支付订单号或商户订单号两种方式查询
    * 注意：
    *  查询订单可通过微信支付订单号和商户订单号两种方式查询，两种查询方式返回结果相同
@@ -389,11 +390,11 @@ public interface WxPayService {
    * 
    * 合单查询订单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
+   * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_11.shtml
    * 

    *
    * @param combineOutTradeNo 合单商户订单号
-   * @return 合单支付订单信息
+   * @return 合单支付订单信息 combine query result
    * @throws WxPayException the wx pay exception
    */
   CombineQueryResult queryCombine(String combineOutTradeNo) throws WxPayException;
@@ -472,7 +473,7 @@ public interface WxPayService {
    * 
    * 合单关闭订单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
+   * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_12.shtml
    * 

    *
    * @param request 请求对象
@@ -498,7 +499,7 @@ public interface WxPayService {
    * @param request           统一下单请求参数，设定的 tradeType 及配置里的 tradeType 将被忽略，转而使用 specificTradeType
    * @return 返回 {@link WxPayConstants.TradeType.Specific} 指定的类
    * @throws WxPayException the wx pay exception
-   * @see WxPayService#createOrder(WxPayUnifiedOrderRequest) WxPayService#createOrder(WxPayUnifiedOrderRequest)
+   * @see WxPayService#createOrder(WxPayUnifiedOrderRequest) WxPayService#createOrder(WxPayUnifiedOrderRequest)WxPayService#createOrder(WxPayUnifiedOrderRequest)
    */
    T createOrder(WxPayConstants.TradeType.Specific specificTradeType, WxPayUnifiedOrderRequest request) throws WxPayException;
 
@@ -516,8 +517,9 @@ public interface WxPayService {
   /**
    * 调用统一下单接口，并组装生成支付所需参数对象.
    *
-   * @param      请使用{@link com.github.binarywang.wxpay.bean.result.WxPayUnifiedOrderV3Result}里的内部类或字段
-   * @param request 统一下单请求参数
+   * @param        请使用{@link com.github.binarywang.wxpay.bean.result.WxPayUnifiedOrderV3Result}里的内部类或字段
+   * @param tradeType the trade type
+   * @param request   统一下单请求参数
    * @return 返回 {@link com.github.binarywang.wxpay.bean.result.WxPayUnifiedOrderV3Result}里的内部类或字段
    * @throws WxPayException the wx pay exception
    */
@@ -526,7 +528,8 @@ public interface WxPayService {
   /**
    * 在发起微信支付前，需要调用统一下单接口，获取"预支付交易会话标识"
    *
-   * @param request 请求对象，注意一些参数如appid、mchid等不用设置，方法内会自动从配置对象中获取到（前提是对应配置中已经设置）
+   * @param tradeType the trade type
+   * @param request   请求对象，注意一些参数如appid、mchid等不用设置，方法内会自动从配置对象中获取到（前提是对应配置中已经设置）
    * @return the wx pay unified order result
    * @throws WxPayException the wx pay exception
    */
@@ -540,7 +543,7 @@ public interface WxPayService {
    *  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
+   * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/open/pay/chapter2_9_3.shtml
    * 

    *
    * @param tradeType 支付方式
@@ -558,9 +561,10 @@ public interface WxPayService {
    *  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
+   * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/open/pay/chapter2_9_3.shtml
    *
* + * @param the type parameter * @param tradeType 支付方式 * @param request 请求对象 * @return 调起支付需要的参数 t @@ -597,7 +601,7 @@ public interface WxPayService { /** * 
    * 微信支付-申请退款.
-   * 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_4
+   * 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_4
    * 接口链接：https://api.mch.weixin.qq.com/secapi/pay/refund
    *
* @@ -610,7 +614,7 @@ public interface WxPayService { /** * 
    * 申请退款API（支持单品）.
-   * 详见 https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_103&index=3
+   * 详见 https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_103&index=3
    *
    * 应用场景
    * 当交易发生之后一段时间内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付款退还给买家，微信支付将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退到买家帐号上。
@@ -637,7 +641,7 @@ public interface WxPayService {
   /**
    * 
    * 申请退款API（支持单品）.
-   * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_9.shtml
+   * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_9.shtml
    *
    * 应用场景
    * 当交易发生之后一年内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付金额退还给买家，微信支付将在收到退款请求并且验证成功之后，将支付款按原路退还至买家账号上。
@@ -667,7 +671,7 @@ public interface WxPayService {
    * 应用场景：
    *  提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，用零钱支付的退款20分钟内到账，
    *  银行卡支付的退款3个工作日后重新查询退款状态。
-   * 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_5
+   * 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_5
    * 接口链接：https://api.mch.weixin.qq.com/pay/refundquery
    * 

    * 以下四个参数四选一
@@ -688,7 +692,7 @@ public interface WxPayService {
    * 应用场景：
    *  提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，用零钱支付的退款20分钟内到账，
    *  银行卡支付的退款3个工作日后重新查询退款状态。
-   * 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_5
+   * 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_5
    * 接口链接：https://api.mch.weixin.qq.com/pay/refundquery
    *
* @@ -712,7 +716,7 @@ public interface WxPayService { * 接口地址 * 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 + * 详见 https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_104&index=4 * * * @param request 微信退款单号 @@ -726,7 +730,7 @@ public interface WxPayService { * 微信支付-查询退款 * 应用场景： * 提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，建议在提交退款申请后1分钟发起查询退款状态，一般来说零钱支付的退款5分钟内到账，银行卡支付的退款1-3个工作日到账。 - * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_10.shtml + * 详见 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} * * @@ -741,7 +745,7 @@ public interface WxPayService { * 微信支付-查询退款 * 应用场景： * 提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，建议在提交退款申请后1分钟发起查询退款状态，一般来说零钱支付的退款5分钟内到账，银行卡支付的退款1-3个工作日到账。 - * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_10.shtml + * 详见 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} * * @@ -786,7 +790,7 @@ public interface WxPayService { /** * 
    * 合单支付通知回调数据处理
-   * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_13.shtml
+   * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_13.shtml
    *
* * @param notifyData 通知数据 @@ -844,7 +848,7 @@ public interface 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 + * 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_4 * * * @param productId 产品Id @@ -860,7 +864,7 @@ public interface 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 + * 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_4 * * * @param productId 产品Id @@ -873,7 +877,7 @@ public interface WxPayService { * 扫码支付模式二生成二维码的方法. * 对应链接格式：weixin：//wxpay/bizpayurl?sr=XXXXX。请商户调用第三方库将code_url生成二维码图片。 * 该模式链接较短，生成的二维码打印到结账小票上的识别率较高。 - * 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_5 + * 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_5 * * * @param codeUrl 微信返回的交易会话的二维码链接 @@ -890,7 +894,7 @@ public interface WxPayService { * 商户在调用微信支付提供的相关接口时，会得到微信支付返回的相关信息以及获得整个接口的响应时间。 * 为提高整体的服务水平，协助商户一起提高服务质量，微信支付提供了相关接口调用耗时和返回信息的主动上报接口， * 微信支付可以根据商户侧上报的数据进一步优化网络部署，完善服务监控，和商户更好的协作为用户提供更好的业务体验。 - * 接口地址： https://api.mch.weixin.qq.com/payitil/report + * 接口地址： https://api.mch.weixin.qq.com/payitil/report * 是否需要证书：不需要 * * @@ -908,7 +912,7 @@ public interface WxPayService { * 2、微信在次日9点启动生成前一天的对账单，建议商户10点后再获取； * 3、对账单中涉及金额的字段单位为“元”。 * 4、对账单接口只能下载三个月以内的账单。 - * 接口链接：https://api.mch.weixin.qq.com/pay/downloadbill + * 接口链接：https://api.mch.weixin.qq.com/pay/downloadbill * 详情请见: 下载对账单 * * @@ -1027,7 +1031,7 @@ public interface WxPayService { * • 微信侧未成功下单的交易不会出现在对账单中。支付成功后撤销的交易会出现在对账单中，跟原支付单订单号一致； * • 对账单中涉及金额的字段单位为“元”； * • 对账单接口只能下载三个月以内的账单。 - * 接口链接：https://api.mch.weixin.qq.com/v3/bill/tradebill + * 接口链接：https://api.mch.weixin.qq.com/v3/bill/tradebill * 详情请见: 申请交易账单 * * @@ -1044,7 +1048,7 @@ public interface WxPayService { * 注意： * • 资金账单中的数据反映的是商户微信支付账户资金变动情况； * • 对账单中涉及金额的字段单位为“元”。 - * 接口链接：https://api.mch.weixin.qq.com/v3/bill/fundflowbill + * 接口链接：https://api.mch.weixin.qq.com/v3/bill/fundflowbill * 详情请见: 申请资金账单 * * @@ -1075,12 +1079,12 @@ public interface WxPayService { /** * 
    * 提交付款码支付.
-   * 文档地址：https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_10&index=1
+   * 文档地址：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
+   * 接口地址：   https://api.mch.weixin.qq.com/pay/micropay
    * 是否需要证书：不需要。
    *
* @@ -1114,10 +1118,10 @@ public interface WxPayService { * 
    *  转换短链接.
    *  文档地址：
-   *     https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_9&index=8
+   *     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
+   *  接口地址：https://api.mch.weixin.qq.com/tools/shorturl
    *  是否需要证书：否
    *
* @@ -1135,7 +1139,7 @@ public interface WxPayService { * @param longUrl 需要被压缩的网址 * @return the string * @throws WxPayException the wx pay exception - * @see WxPayService#shorturl(WxPayShorturlRequest) WxPayService#shorturl(WxPayShorturlRequest)WxPayService#shorturl(WxPayShorturlRequest) + * @see WxPayService#shorturl(WxPayShorturlRequest) WxPayService#shorturl(WxPayShorturlRequest)WxPayService#shorturl(WxPayShorturlRequest)WxPayService#shorturl(WxPayShorturlRequest) */ String shorturl(String longUrl) throws WxPayException; @@ -1144,7 +1148,7 @@ public interface WxPayService { * 授权码查询OPENID接口. * 通过授权码查询公众号Openid，调用查询后，该授权码只能由此商户号发起扣款，直至授权码更新。 * 文档地址： - * https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_13&index=9 + * https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_13&index=9 * 接口链接: * https://api.mch.weixin.qq.com/tools/authcodetoopenid * @@ -1163,7 +1167,7 @@ public interface WxPayService { * @param authCode 授权码 * @return openid string * @throws WxPayException the wx pay exception - * @see WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest) WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest)WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest) + * @see WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest) WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest)WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest)WxPayService#authcode2Openid(WxPayAuthcode2OpenidRequest) */ String authcode2Openid(String authCode) throws WxPayException;