🎨 优化部分文档

This commit is contained in:
Binary Wang 2022-04-15 17:30:55 +08:00
parent b6ee83d119
commit a0dcda4ac1

View File

@ -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<String, WxPayConfig> 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 {
/**
* 获取分账服务类.
* <p>
* V3接口 {@link WxPayService#getProfitSharingV3Service()}
* V3接口 {@link WxPayService#getProfitSharingV3Service()}
* </p>
*
* @return the ent pay service
@ -341,7 +342,7 @@ public interface WxPayService {
/**
* <pre>
* 查询订单
* 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml
* 详见 <a href="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</a>
* 商户可以通过查询订单接口主动查询订单状态完成下一步的业务逻辑查询订单状态可通过微信支付订单号或商户订单号两种方式查询
* 注意
* 查询订单可通过微信支付订单号和商户订单号两种方式查询两种查询方式返回结果相同
@ -365,7 +366,7 @@ public interface WxPayService {
/**
* <pre>
* 查询订单
* 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_2.shtml
* 详见 <a href="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</a>
* 商户可以通过查询订单接口主动查询订单状态完成下一步的业务逻辑查询订单状态可通过微信支付订单号或商户订单号两种方式查询
* 注意
* 查询订单可通过微信支付订单号和商户订单号两种方式查询两种查询方式返回结果相同
@ -389,11 +390,11 @@ public interface WxPayService {
* <pre>
* 合单查询订单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
* 文档地址: <a href="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</a>
* </pre>
*
* @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 {
* <pre>
* 合单关闭订单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
* 文档地址: <a href="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</a>
* </pre>
*
* @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> T createOrder(WxPayConstants.TradeType.Specific<T> specificTradeType, WxPayUnifiedOrderRequest request) throws WxPayException;
@ -516,8 +517,9 @@ public interface WxPayService {
/**
* 调用统一下单接口并组装生成支付所需参数对象.
*
* @param <T> 请使用{@link com.github.binarywang.wxpay.bean.result.WxPayUnifiedOrderV3Result}里的内部类或字段
* @param request 统一下单请求参数
* @param <T> 请使用{@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 请求对象注意一些参数如appidmchid等不用设置方法内会自动从配置对象中获取到前提是对应配置中已经设置
* @param tradeType the trade type
* @param request 请求对象注意一些参数如appidmchid等不用设置方法内会自动从配置对象中获取到前提是对应配置中已经设置
* @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
* 文档地址: <a href="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</a>
* </pre>
*
* @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
* 文档地址: <a href="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</a>
* </pre>
*
* @param <T> the type parameter
* @param tradeType 支付方式
* @param request 请求对象
* @return 调起支付需要的参数 t
@ -597,7 +601,7 @@ public interface WxPayService {
/**
* <pre>
* 微信支付-申请退款.
* 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_4
* 详见 <a href="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</a>
* 接口链接https://api.mch.weixin.qq.com/secapi/pay/refund
* </pre>
*
@ -610,7 +614,7 @@ public interface WxPayService {
/**
* <pre>
* 申请退款API支持单品.
* 详见 https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_103&index=3
* 详见 <a href="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</a>
*
* 应用场景
* 当交易发生之后一段时间内由于买家或者卖家的原因需要退款时卖家可以通过退款接口将支付款退还给买家微信支付将在收到退款请求并且验证成功之后按照退款规则将支付款按原路退到买家帐号上
@ -637,7 +641,7 @@ public interface WxPayService {
/**
* <pre>
* 申请退款API支持单品.
* 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_9.shtml
* 详见 <a href="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</a>
*
* 应用场景
* 当交易发生之后一年内由于买家或者卖家的原因需要退款时卖家可以通过退款接口将支付金额退还给买家微信支付将在收到退款请求并且验证成功之后将支付款按原路退还至买家账号上
@ -667,7 +671,7 @@ public interface WxPayService {
* 应用场景
* 提交退款申请后通过调用该接口查询退款状态退款有一定延时用零钱支付的退款20分钟内到账
* 银行卡支付的退款3个工作日后重新查询退款状态
* 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_5
* 详见 <a href="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</a>
* 接口链接https://api.mch.weixin.qq.com/pay/refundquery
* </pre>
* 以下四个参数四选一
@ -688,7 +692,7 @@ public interface WxPayService {
* 应用场景
* 提交退款申请后通过调用该接口查询退款状态退款有一定延时用零钱支付的退款20分钟内到账
* 银行卡支付的退款3个工作日后重新查询退款状态
* 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_5
* 详见 <a href="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</a>
* 接口链接https://api.mch.weixin.qq.com/pay/refundquery
* </pre>
*
@ -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
* 详见 <a href="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</a>
* </pre>
*
* @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
* 详见 <a href="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</a>
* 接口链接https://api.mch.weixin.qq.com/v3/refund/domestic/refunds/{out_refund_no}
* </pre>
*
@ -741,7 +745,7 @@ public interface WxPayService {
* 微信支付-查询退款
* 应用场景
* 提交退款申请后通过调用该接口查询退款状态退款有一定延时建议在提交退款申请后1分钟发起查询退款状态一般来说零钱支付的退款5分钟内到账银行卡支付的退款1-3个工作日到账
* 详见 https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_10.shtml
* 详见 <a href="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</a>
* 接口链接https://api.mch.weixin.qq.com/v3/refund/domestic/refunds/{out_refund_no}
* </pre>
*
@ -786,7 +790,7 @@ public interface WxPayService {
/**
* <pre>
* 合单支付通知回调数据处理
* 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_13.shtml
* 文档地址: <a href="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</a>
* </pre>
*
* @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
* 文档详见: <a href="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</a>
* </pre>
*
* @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
* 文档详见: <a href="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</a>
* </pre>
*
* @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
* 文档详见: <a href="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</a>
* </pre>
*
* @param codeUrl 微信返回的交易会话的二维码链接
@ -890,7 +894,7 @@ public interface WxPayService {
* 商户在调用微信支付提供的相关接口时会得到微信支付返回的相关信息以及获得整个接口的响应时间
* 为提高整体的服务水平协助商户一起提高服务质量微信支付提供了相关接口调用耗时和返回信息的主动上报接口
* 微信支付可以根据商户侧上报的数据进一步优化网络部署完善服务监控和商户更好的协作为用户提供更好的业务体验
* 接口地址 https://api.mch.weixin.qq.com/payitil/report
* 接口地址 <a href="https://api.mch.weixin.qq.com/payitil/report">https://api.mch.weixin.qq.com/payitil/report</a>
* 是否需要证书不需要
* </pre>
*
@ -908,7 +912,7 @@ public interface WxPayService {
* 2微信在次日9点启动生成前一天的对账单建议商户10点后再获取
* 3对账单中涉及金额的字段单位为
* 4对账单接口只能下载三个月以内的账单
* 接口链接https://api.mch.weixin.qq.com/pay/downloadbill
* 接口链接<a href="https://api.mch.weixin.qq.com/pay/downloadbill">https://api.mch.weixin.qq.com/pay/downloadbill</a>
* 详情请见: <a href="https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_6">下载对账单</a>
* </pre>
*
@ -1027,7 +1031,7 @@ public interface WxPayService {
* 微信侧未成功下单的交易不会出现在对账单中支付成功后撤销的交易会出现在对账单中跟原支付单订单号一致
* 对账单中涉及金额的字段单位为
* 对账单接口只能下载三个月以内的账单
* 接口链接https://api.mch.weixin.qq.com/v3/bill/tradebill
* 接口链接<a href="https://api.mch.weixin.qq.com/v3/bill/tradebill">https://api.mch.weixin.qq.com/v3/bill/tradebill</a>
* 详情请见: <a href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_6.shtml">申请交易账单</a>
* </pre>
*
@ -1044,7 +1048,7 @@ public interface WxPayService {
* 注意
* 资金账单中的数据反映的是商户微信支付账户资金变动情况
* 对账单中涉及金额的字段单位为
* 接口链接https://api.mch.weixin.qq.com/v3/bill/fundflowbill
* 接口链接<a href="https://api.mch.weixin.qq.com/v3/bill/fundflowbill">https://api.mch.weixin.qq.com/v3/bill/fundflowbill</a>
* 详情请见: <a href="https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_7.shtml">申请资金账单</a>
* </pre>
*
@ -1075,12 +1079,12 @@ public interface WxPayService {
/**
* <pre>
* 提交付款码支付.
* 文档地址https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_10&index=1
* 文档地址<a href="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</a>
* 应用场景
* 收银员使用扫码设备读取微信用户刷卡授权码以后二维码或条码信息传送至商户收银台由商户收银台或者商户后台调用该接口发起支付
* 提醒1提交支付请求后微信会同步返回支付结果当返回结果为系统错误商户系统等待5秒后调用查询订单API查询支付实际交易结果当返回结果为USERPAYING商户系统可设置间隔时间(建议10秒)重新查询支付结果直到支付成功或超时(建议30秒)
* 提醒2在调用查询接口返回后如果交易状况不明晰请调用撤销订单API此时如果交易失败则关闭订单该单不能再支付成功如果交易成功则将扣款退回到用户账户当撤销无返回或错误时请再次调用注意请勿扣款后立即调用撤销订单API,建议至少15秒后再调用撤销订单API需要双向证书
* 接口地址 https://api.mch.weixin.qq.com/pay/micropay
* 接口地址 <a href="https://api.mch.weixin.qq.com/pay/micropay">https://api.mch.weixin.qq.com/pay/micropay</a>
* 是否需要证书不需要
* </pre>
*
@ -1114,10 +1118,10 @@ public interface WxPayService {
* <pre>
* 转换短链接.
* 文档地址
* https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_9&index=8
* <a href="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</a>
* 应用场景
* 该接口主要用于扫码原生支付模式一中的二维码链接转成短链接(weixin://wxpay/s/XXXXXX)减小二维码数据量提升扫描速度和精确度
* 接口地址https://api.mch.weixin.qq.com/tools/shorturl
* 接口地址<a href="https://api.mch.weixin.qq.com/tools/shorturl">https://api.mch.weixin.qq.com/tools/shorturl</a>
* 是否需要证书
* </pre>
*
@ -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
* <a href="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</a>
* 接口链接:
* https://api.mch.weixin.qq.com/tools/authcodetoopenid
* </pre>
@ -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;