PaymentProxy (weixin-common 1.2.0 API)

java.lang.Object
- cn.ipokerface.weixin.proxy.AbstractProxy
- - cn.ipokerface.weixin.proxy.MerchantProxy
  - - cn.ipokerface.weixin.proxy.PaymentProxy

```
public class PaymentProxy
extends MerchantProxy
```
Created by PokerFace Create Date 2019-12-28. Email: 214888341@163.com Version 1.0.0
Description:

字段概要
- 从类继承的字段 cn.ipokerface.weixin.proxy.MerchantProxy
  weixinPayAccount, weixinSignature
- 从类继承的字段 cn.ipokerface.weixin.proxy.AbstractProxy
  weixinRequestClient

构造器概要

构造器
构造器和说明

PaymentProxy(WeixinPayAccount weixinAccount)

构造器
构造器和说明
`PaymentProxy(WeixinPayAccount weixinAccount)`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`RefundResult`	`applyRefund(IdQuery idQuery, String outRefundNo, double totalFee)` 退款申请(全额退款)
`RefundResult`	`applyRefund(IdQuery idQuery, String outRefundNo, double totalFee, double refundFee, CurrencyType refundFeeType, String opUserId, String refundDesc, RefundAccountType refundAccountType)` 申请退款(请求需要双向证书) 当交易发生之后一段时间内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付款退还给买家，微信支付将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退到买家帐号上。
`OpenidResult`	`authCode2openId(String authCode)` 授权码查询OPENID接口
`MerchantResult`	`closeOrder(String outTradeNo)` 关闭订单商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付；系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口,如果关单失败,返回已完成支付请按正常支付处理。
`String`	`createAddressRequestJSON(String url, String oauthToken)` 生成编辑地址请求 err_msg edit_address:ok获取编辑收货地址成功 edit_address:fail获取编辑收货地址失败 userName 收货人姓名 telNumber 收货人电话 addressPostalCode 邮编 proviceFirstStageName 国标收货地址第一级地址 addressCitySecondStageName 国标收货地址第二级地址 addressCountiesThirdStageName 国标收货地址第三级地址 addressDetailInfo 详细收货地址信息nationalCode 收货地址国家码
`MerchantPaymentRequest`	`createAppPayRequest(String body, String outTradeNo, double totalFee, String notifyUrl, String createIp, String attach, SceneInfoStore store)` 创建APP支付请求对象
`MerchantPaymentRequest`	`createJSPayRequest(String openId, String body, String outTradeNo, double totalFee, String notifyUrl, String createIp, String attach)` 创建JSAPI支付请求对象
`MerchantPaymentRequest`	`createMicroPayRequest(String authCode, String body, String outTradeNo, double totalFee, String createIp, String attach, SceneInfoStore store)` 提交被扫支付
`String`	`createNativePayRequest(String productId)` 创建Native支付(扫码支付)链接【模式一】
`MerchantPaymentRequest`	`createNativePayRequest(String productId, String body, String outTradeNo, double totalFee, String notifyUrl, String createIp, String attach)` 创建Native支付(扫码支付)链接【模式二】
`NativePaymentResponse`	`createNativePayResponse(String productId, String body, String outTradeNo, double totalFee, String notifyUrl, String createIp, String attach)` 创建Native支付(扫码支付)回调对象【模式一】
`MerchantPaymentRequest`	`createPayRequest(MerchantPaymentPackage payPackage)` 创建支付请求对象
`PrePayment`	`createPrePay(MerchantPaymentPackage payPackage)` 统一下单接口除被扫支付场景以外，商户系统先调用该接口在微信支付服务后台生成预支付交易单，返回正确的预支付交易回话标识后再按扫码、JSAPI 、APP等不同场景生成交易串调起支付。
`MerchantPaymentRequest`	`createWapPayRequest(String body, String outTradeNo, double totalFee, String notifyUrl, String createIp, String attach, SceneInfoApp app)` 创建WAP支付请求对象：正常流程用户支付完成后会返回至发起支付的页面，如需返回至指定页面，则可以在MWEB_URL后拼接上redirect_url参数，来指定回调页面
`void`	`downloadBill(Date billDate, BillType billType, OutputStream outputStream, ZipType tarType)` 下载对账单 1.微信侧未成功下单的交易不会出现在对账单中。
`String`	`getShorturl(String url)` native支付URL转短链接：用于扫码原生支付模式一中的二维码链接转成短链接(weixin://wxpay/s/XXXXXX)，减小二维码数据量，提升扫描速度和精确度。
`Order`	`queryOrder(IdQuery idQuery)` 订单查询当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知；调用支付接口后，返回系统错误或未知交易状态情况；调用被扫支付API，返回USERPAYING的状态；调用关单或撤销接口API之前，需确认支付状态；
`RefundRecord`	`queryRefund(IdQuery idQuery)` 退款查询提交退款申请后，通过调用该接口查询退款状态。
`ApiXmlResult`	`reportInterface(String interfaceUrl, int executeTime, String outTradeNo, String ip, Date time, ApiXmlResult returnXml)` 接口上报
`MerchantResult`	`reverseOrder(IdQuery idQuery)` 冲正订单(需要证书)当支付返回失败,或收银系统超时需要取消交易,可以调用该接口接口逻辑:支付失败的关单,支付成功的撤销支付7天以内的单可撤销,其他正常支付的单如需实现相同功能请调用退款接口调用扣款接口后请勿立即调用撤销,需要等待5秒以上。

从类继承的方法 cn.ipokerface.weixin.proxy.MerchantProxy
createBaseRequestMap, declareMerchant, getWeixinSignature, getWeixinSSLExecutor

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

- 构造器详细资料
  - PaymentProxy
```
public PaymentProxy(WeixinPayAccount weixinAccount)
```
- 方法详细资料
  - createPrePay
```
public PrePayment createPrePay(MerchantPaymentPackage payPackage)
                        throws WeixinException
```
    统一下单接口除被扫支付场景以外，商户系统先调用该接口在微信支付服务后台生成预支付交易单，返回正确的预支付交易回话标识后再按扫码、JSAPI 、APP等不同场景生成交易串调起支付。
    
    参数:
    
    payPackage - 包含订单信息的对象
    
    返回:
    
    预支付对象
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    MerchantPaymentPackage, PrePayment, 统一下单接口
  - createPayRequest
```
public MerchantPaymentRequest createPayRequest(MerchantPaymentPackage payPackage)
                                        throws WeixinException
```
    创建支付请求对象
    
    参数:
    
    payPackage - 支付详情
    
    返回:
    
    支付请求对象
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    JS支付, 扫码支付, 刷卡支付, APP支付, WAP支付
  - createJSPayRequest
```
public MerchantPaymentRequest createJSPayRequest(String openId,
                                                 String body,
                                                 String outTradeNo,
                                                 double totalFee,
                                                 String notifyUrl,
                                                 String createIp,
                                                 String attach)
                                          throws WeixinException
```
    创建JSAPI支付请求对象
    
    参数:
    
    openId - 用户ID
    
    body - 订单描述
    
    outTradeNo - 订单号
    
    totalFee - 订单总额(元)
    
    notifyUrl - 支付通知地址
    
    createIp - ip地址
    
    attach - 附加数据非必填
    
    返回:
    
    JSAPI支付对象
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    JsapiPaymentRequest
  - createAddressRequestJSON
```
public String createAddressRequestJSON(String url,
                                       String oauthToken)
```
    生成编辑地址请求
    err_msg edit_address:ok获取编辑收货地址成功 edit_address:fail获取编辑收货地址失败 userName 收货人姓名 telNumber 收货人电话 addressPostalCode 邮编 proviceFirstStageName 国标收货地址第一级地址 addressCitySecondStageName 国标收货地址第二级地址 addressCountiesThirdStageName 国标收货地址第三级地址 addressDetailInfo 详细收货地址信息nationalCode 收货地址国家码
    
    参数:
    
    url - 当前访问页的URL
    
    oauthToken - oauth授权时产生的token
    
    返回:
    
    编辑地址请求JSON串
    
    另请参阅:
    
    收货地址共享
  - createNativePayRequest
```
public String createNativePayRequest(String productId)
```
    创建Native支付(扫码支付)链接【模式一】
    
    参数:
    
    productId - 与订单ID等价
    
    返回:
    
    支付链接
    
    另请参阅:
    
    扫码支付 , 模式一
  - createNativePayResponse
```
public NativePaymentResponse createNativePayResponse(String productId,
                                                     String body,
                                                     String outTradeNo,
                                                     double totalFee,
                                                     String notifyUrl,
                                                     String createIp,
                                                     String attach)
                                              throws WeixinException
```
    创建Native支付(扫码支付)回调对象【模式一】
    
    参数:
    
    productId - 商品ID
    
    body - 商品描述
    
    outTradeNo - 商户内部唯一订单号
    
    totalFee - 商品总额单位元
    
    notifyUrl - 支付回调URL
    
    createIp - 订单生成的机器 IP
    
    attach - 附加数据非必填
    
    返回:
    
    Native回调对象
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    NativePaymentResponse, 扫码支付 , 模式一
  - createNativePayRequest
```
public MerchantPaymentRequest createNativePayRequest(String productId,
                                                     String body,
                                                     String outTradeNo,
                                                     double totalFee,
                                                     String notifyUrl,
                                                     String createIp,
                                                     String attach)
                                              throws WeixinException
```
    创建Native支付(扫码支付)链接【模式二】
    
    参数:
    
    productId - 商品ID
    
    body - 商品描述
    
    outTradeNo - 商户内部唯一订单号
    
    totalFee - 商品总额单位元
    
    notifyUrl - 支付回调URL
    
    createIp - 订单生成的机器 IP
    
    attach - 附加数据非必填
    
    返回:
    
    Native支付对象
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    NativePaymentRequest, 扫码支付 , 模式二
  - createAppPayRequest
```
public MerchantPaymentRequest createAppPayRequest(String body,
                                                  String outTradeNo,
                                                  double totalFee,
                                                  String notifyUrl,
                                                  String createIp,
                                                  String attach,
                                                  SceneInfoStore store)
                                           throws WeixinException
```
    创建APP支付请求对象
    
    参数:
    
    body - 商品描述
    
    outTradeNo - 商户内部唯一订单号
    
    totalFee - 商品总额单位元
    
    notifyUrl - 支付回调URL
    
    createIp - 订单生成的机器 IP
    
    attach - 附加数据非必填
    
    store - 门店信息非必填
    
    返回:
    
    APP支付对象
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    SceneInfoStore, AppPaymentRequest, APP支付
  - createWapPayRequest
```
public MerchantPaymentRequest createWapPayRequest(String body,
                                                  String outTradeNo,
                                                  double totalFee,
                                                  String notifyUrl,
                                                  String createIp,
                                                  String attach,
                                                  SceneInfoApp app)
                                           throws WeixinException
```
    创建WAP支付请求对象：正常流程用户支付完成后会返回至发起支付的页面，如需返回至指定页面，则可以在MWEB_URL后拼接上redirect_url参数，来指定回调页面
    
    参数:
    
    body - 商品描述
    
    outTradeNo - 商户内部唯一订单号
    
    totalFee - 商品总额单位元
    
    notifyUrl - 支付回调URL
    
    createIp - 订单生成的机器 IP
    
    attach - 附加数据非必填
    
    app - 应用信息
    
    返回:
    
    WAP支付对象
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    SceneInfoApp, WapPaymentRequest, WAP支付
  - createMicroPayRequest
```
public MerchantPaymentRequest createMicroPayRequest(String authCode,
                                                    String body,
                                                    String outTradeNo,
                                                    double totalFee,
                                                    String createIp,
                                                    String attach,
                                                    SceneInfoStore store)
                                             throws WeixinException
```
    提交被扫支付
    
    参数:
    
    authCode - 扫码支付授权码 ,设备读取用户微信中的条码或者二维码信息
    
    body - 商品描述
    
    outTradeNo - 商户内部唯一订单号
    
    totalFee - 商品总额单位元
    
    createIp - 订单生成的机器 IP
    
    attach - 附加数据非必填
    
    store - 门店信息非必填
    
    返回:
    
    支付的订单信息
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    MicroPaymentRequest, Order, SceneInfoStore, 提交被扫支付API
  - queryOrder
```
public Order queryOrder(IdQuery idQuery)
                 throws WeixinException
```
    订单查询
    当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知；调用支付接口后，返回系统错误或未知交易状态情况；调用被扫支付API，返回USERPAYING的状态；调用关单或撤销接口API之前，需确认支付状态；
    
    参数:
    
    idQuery - 商户系统内部的订单号, transaction_id、out_trade_no 二选一,如果同时存在优先级: transaction_id > out_trade_no
    
    返回:
    
    订单信息
    
    抛出:
    
    WeixinException
    
    从以下版本开始:
    
    V3
    
    另请参阅:
    
    Order, 订单查询API
  - applyRefund
```
public RefundResult applyRefund(IdQuery idQuery,
                                String outRefundNo,
                                double totalFee,
                                double refundFee,
                                CurrencyType refundFeeType,
                                String opUserId,
                                String refundDesc,
                                RefundAccountType refundAccountType)
                         throws WeixinException
```
    申请退款(请求需要双向证书)
    当交易发生之后一段时间内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付款退还给买家，微信支付将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退到买家帐号上。
    1. 交易时间超过一年的订单无法提交退款；
    2. 微信支付退款支持单笔交易分多次退款，多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。一笔退款失败后重新提交，请不要更换退款单号，请使用原商户退款单号。
    3. 请求频率限制：150qps，即每秒钟正常的申请退款请求次数不超过150次。错误或无效请求频率限制：6qps，即每秒钟异常或错误的退款申请请求不超过6次。
    4. 每个支付订单的部分退款次数不能超过50次。
    参数:
    
    idQuery - 商户系统内部的订单号, transaction_id 、 out_trade_no 二选一,如果同时存在优先级: transaction_id > out_trade_no
    
    outRefundNo - 商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔
    
    totalFee - 订单总金额,单位为元
    
    refundFee - 退款总金额,单位为元,可以做部分退款
    
    refundFeeType - 货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY
    
    opUserId - 操作员帐号, 默认为商户号
    
    refundDesc - 退款原因，若商户传入，会在下发给用户的退款消息中体现退款原因
    
    refundAccountType - 退款资金来源,默认使用未结算资金退款：REFUND_SOURCE_UNSETTLED_FUNDS
    
    返回:
    
    退款申请结果
    
    抛出:
    
    WeixinException
    
    从以下版本开始:
    
    V3
    
    另请参阅:
    
    RefundResult, 申请退款API
  - applyRefund
```
public RefundResult applyRefund(IdQuery idQuery,
                                String outRefundNo,
                                double totalFee)
                         throws WeixinException
```
    退款申请(全额退款)
    
    参数:
    
    idQuery - 商户系统内部的订单号, transaction_id 、 out_trade_no 二选一,如果同时存在优先级: transaction_id > out_trade_no
    
    outRefundNo - 商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔
    
    totalFee - 订单总金额,单位为元
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    applyRefund(IdQuery, String, double, double, CurrencyType, String, String, RefundAccountType)
  - reverseOrder
```
public MerchantResult reverseOrder(IdQuery idQuery)
                            throws WeixinException
```
    冲正订单(需要证书)当支付返回失败,或收银系统超时需要取消交易,可以调用该接口接口逻辑:支付失败的关单,支付成功的撤销支付7天以内的单可撤销,其他正常支付的单如需实现相同功能请调用退款接口调用扣款接口后请勿立即调用撤销,需要等待5秒以上。先调用查单接口,如果没有确切的返回,再调用撤销
    
    参数:
    
    idQuery - 商户系统内部的订单号, transaction_id 、 out_trade_no 二选一,如果同时存在优先级: transaction_id > out_trade_no
    
    返回:
    
    撤销结果
    
    抛出:
    
    WeixinException
    
    从以下版本开始:
    
    V3
  - getShorturl
```
public String getShorturl(String url)
                   throws WeixinException
```
    native支付URL转短链接：用于扫码原生支付模式一中的二维码链接转成短链接(weixin://wxpay/s/XXXXXX)，减小二维码数据量，提升扫描速度和精确度。
    
    参数:
    
    url - 具有native标识的支付URL
    
    返回:
    
    转换后的短链接
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    转换短链接API
  - closeOrder
```
public MerchantResult closeOrder(String outTradeNo)
                          throws WeixinException
```
    关闭订单
    商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付；系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口,如果关单失败,返回已完成支付请按正常支付处理。如果出现银行掉单,调用关单成功后,微信后台会主动发起退款。
    
    参数:
    
    outTradeNo - 商户系统内部的订单号
    
    返回:
    
    处理结果
    
    抛出:
    
    WeixinException
    
    从以下版本开始:
    
    V3
    
    另请参阅:
    
    关闭订单API
  - downloadBill
```
public void downloadBill(Date billDate,
                         BillType billType,
                         OutputStream outputStream,
                         ZipType tarType)
                  throws WeixinException
```
    下载对账单
    1.微信侧未成功下单的交易不会出现在对账单中。支付成功后撤销的交易会出现在对账单中,跟原支付单订单号一致,bill_type 为 REVOKED;
    2.微信在次日 9 点启动生成前一天的对账单,建议商户 9 点半后再获取;
    3.对账单中涉及金额的字段单位为“元”。
    
    参数:
    
    billDate - 下载对账单的日期
    
    billType - 下载对账单的类型 ALL,返回当日所有订单信息, 默认值 SUCCESS,返回当日成功支付的订单 REFUND,返回当日退款订单
    
    outputStream - 输出流
    
    tarType - 非必传参数，固定值：GZIP，返回格式为.gzip的压缩包账单。不传则默认为数据流形式。
    
    抛出:
    
    WeixinException
    
    从以下版本开始:
    
    V3
    
    另请参阅:
    
    下载对账单API
  - queryRefund
```
public RefundRecord queryRefund(IdQuery idQuery)
                         throws WeixinException
```
    退款查询
    提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，用零钱支付的退款20分钟内到账，银行卡支付的退款3个工作日后重新查询退款状态。
    
    参数:
    
    idQuery - 单号 refund_id、out_refund_no、 out_trade_no 、 transaction_id 四个参数必填一个,优先级为: refund_id > out_refund_no > transaction_id > out_trade_no
    
    返回:
    
    退款记录
    
    抛出:
    
    WeixinException
    
    从以下版本开始:
    
    V3
    
    另请参阅:
    
    RefundRecord, RefundDetail, 退款查询API
  - reportInterface
```
public ApiXmlResult reportInterface(String interfaceUrl,
                                    int executeTime,
                                    String outTradeNo,
                                    String ip,
                                    Date time,
                                    ApiXmlResult returnXml)
                             throws WeixinException
```
    接口上报
    
    参数:
    
    interfaceUrl - 上报对应的接口的完整 URL, 类似: https://api.mch.weixin.q q.com/pay/unifiedorder
    
    executeTime - 接口耗时情况,单位为毫秒
    
    outTradeNo - 商户系统内部的订单号,商户可以在上报时提供相关商户订单号方便微信支付更好的提高服务质量。
    
    ip - 发起接口调用时的机器 IP
    
    time - 商户调用该接口时商户自己系统的时间
    
    returnXml - 调用接口返回的基本数据
    
    返回:
    
    处理结果
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    交易保障
  - authCode2openId
```
public OpenidResult authCode2openId(String authCode)
                             throws WeixinException
```
    授权码查询OPENID接口
    
    参数:
    
    authCode - 扫码支付授权码，设备读取用户微信中的条码或者二维码信息
    
    返回:
    
    查询结果
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    OpenidResult, 授权码查询OPENID

类 PaymentProxy

字段概要

从类继承的字段 cn.ipokerface.weixin.proxy.MerchantProxy

从类继承的字段 cn.ipokerface.weixin.proxy.AbstractProxy

构造器概要

方法概要

从类继承的方法 cn.ipokerface.weixin.proxy.MerchantProxy

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

构造器详细资料

PaymentProxy

方法详细资料

createPrePay

createPayRequest

createJSPayRequest

createAddressRequestJSON

createNativePayRequest

createNativePayResponse

createNativePayRequest

createAppPayRequest

createWapPayRequest

createMicroPayRequest

queryOrder

applyRefund

applyRefund

reverseOrder

getShorturl

closeOrder

downloadBill

queryRefund

reportInterface

authCode2openId