payment-spring-boot/docs/wechat_v3_api.md

入口类

WechatApiProvider是本项目微信支付的入口类，已被注入Spring IoC，由它来初始化微信支付相关的API，具体分为直连商户和服务商两个体系。

以下清单请搭配微信支付文档使用。

直连商户

基础支付

• WechatDirectPayApi 基础支付，通过WechatApiProvider#directPayApi初始化
  • jsPay JSAPI/小程序下单
  • appPay APP下单
  • h5Pay H5下单
  • nativePay Native下单
  • 查询订单
    1. queryTransactionById 微信支付订单号查询
    2. queryTransactionByOutTradeNo 商户订单号查询
  • close 关闭订单
  • WechatPayCallback#transactionCallback 支付通知，参见下面回调说明
  • refund 申请退款
  • queryRefundInfo 查询单笔退款
  • WechatPayCallback#refundCallback 退款结果通知，参见下面回调说明
  • downloadTradeBill 申请交易账单，直接下载为gzip或者txt文件
  • downloadFundFlowBill 申请资金账单，直接下载为gzip或者txt文件
• WechatCombinePayApi 合单支付，通过WechatApiProvider#combinePayApi初始化
  • jsPay 合单JSAPI/小程序下单
  • appPay 合单APP下单
  • h5Pay 合单H5下单
  • nativePay 合单Native下单
  • queryTransactionByOutTradeNo 查询订单，合单支付目前只支持商户订单号查询
  • close 合单关闭订单
  • WechatPayCallback#combineTransactionCallback 合单支付通知，参见下面回调说明
  • refund 合单申请退款
  • queryRefundInfo 合单查询单笔退款
  • WechatPayCallback#refundCallback 退款结果通知，参见下面回调说明
  • downloadTradeBill 申请交易账单，直接下载为gzip或者txt文件
  • downloadFundFlowBill 申请资金账单，直接下载为gzip或者txt文件
• 付款码支付，暂时没有V3接口，可通过payment spring boot 提供的V2扩展功能自行实现。

经营能力

微信支付分

• WechatPayScoreApi 微信支付分，通过WechatApiProvider#payScoreApi初始化
  • 公共API
    • createServiceOrder 创建支付分订单
    • queryServiceOrder 查询支付分订单
    • cancelServiceOrder 取消支付分订单
    • modifyServiceOrder 修改订单金额
    • completeServiceOrder 完结支付分订单
    • syncServiceOrder 同步服务订单信息
    • WechatPayCallback#payscoreUserOrderCallback 支付成功回调通知，参见下面回调说明
    • refund 支付分申请退款
    • queryRefundInfo 支付分查询单笔退款
    • WechatPayCallback#refundCallback 支付分退款结果通知，参见下面回调说明
  • 免确认预授权模式
    • permissions 商户预授权
    • queryPermissionsByAuthCode 查询与用户授权记录（授权协议号）
    • terminatePermissionsByAuthCode 解除用户授权关系（授权协议号）
    • queryPermissionsByOpenId 查询与用户授权记录（openid）
    • terminatePermissionsByOpenId 解除用户授权关系（openid）
    • WechatPayCallback#permissionCallback 开启/解除授权服务回调通知，参见下面回调说明
  • 需确认模式
    • WechatPayCallback#payscoreUserOrderCallback 确认订单回调通知，参见下面回调说明

支付即服务

• WechatSmartGuideApi 支付即服务，通过WechatApiProvider#smartGuideApi初始化
  • register 服务人员注册
  • assign 服务人员分配
  • query 服务人员查询
  • modify 服务人员信息更新

行业方案

智慧商圈

• WechatBusinessCircleApi 智慧商圈，通过WechatApiProvider#businessCircleApi初始化
  • 商圈会员积分服务授权结果通知回调（未实现）
  • WechatPayCallback#mallTransactionCallback 商圈会员场内支付结果通知，参见下面回调说明
  • apply 商圈积分同步
  • WechatPayCallback#mallRefundCallback 商圈会员场内退款通知，参见下面回调说明
  • queryAuthStatus 商圈积分授权查询
  • 商圈会员待积分状态查询（未实现）
  • 商圈会员停车状态同步（未实现）

微信支付分停车服务

• WechatPayScoreParkingApi 微信支付分停车服务，通过WechatApiProvider#payScoreParkingApi初始化
  • find 查询车牌服务开通信息
  • parking 创建停车入场
  • transactionsParking 扣费受理
  • queryTransactionByOutTradeNo 查询订单
  • WechatPayCallback#payscoreParkingCallback 停车入场状态变更通知，参见下面回调说明
  • WechatPayCallback#payscoreTransParkingCallback 订单支付结果通知，参见下面回调说明
  • refund 申请退款
  • queryRefundInfo 查询单笔退款
  • WechatPayCallback#refundCallback 退款结果通知，参见下面回调说明

营销工具

代金券

• WechatMarketingFavorApi 代金券，通过WechatApiProvider#payScoreParkingApi初始化
  • createStock 创建代金券批次
  • startStock 激活代金券批次
  • sendStock 发放代金券
  • pauseStock 暂停代金券批次
  • restartStock 重启代金券批次
  • queryStocksByMch 条件查询批次列表
  • queryStockDetail 查询批次详情
  • queryCouponDetails 查询代金券详情
  • queryMerchantsByStockId 查询代金券可用商户
  • queryStockItems 查询代金券可用单品
  • queryUserCouponsByMchId 根据商户号查用户的券
  • downloadStockUseFlow 下载批次核销明细
  • downloadStockRefundFlow 下载批次退款明细
  • setMarketingFavorCallback 设置消息通知地址
  • WechatPayCallback#couponCallback 核销事件回调通知，参见下面回调说明
  • sendCouponsCard 发放消费卡

sendCouponsCard 发放消费卡，功能仅向指定邀约商户开放，如有需要请联系微信支付运营经理。

商家券

• WechatMarketingBusiFavorApi 商家券，通过WechatApiProvider#busiFavorApi初始化
  • createStock 创建商家券券批次
  • queryStockDetail 查询商家券详情
  • use 核销用户券
  • queryUserStocks 根据过滤条件查询用户券
  • queryUserCoupon 查询用户单张券详情
  • uploadCouponCodes 上传预存code
  • setCallbacks 设置商家券事件通知地址
  • getCallbacks 查询商家券事件通知地址
  • associate 关联订单信息
  • disassociate 取消关联订单信息
  • budget 修改批次预算
  • updateStock 修改商家券基本信息
  • refund 申请退券
  • deactivate 使券失效
  • payMakeup 营销补差付款
  • queryMakeup 查询营销补差付款单详情
  • payMakeup 营销补差付款
  • WechatPayCallback#busiFavorReceiveCallback 领券事件回调通知，参见下面回调说明

委托营销

• WechatMarketingPartnershipApi 委托营销，通过WechatApiProvider#marketingshipApi初始化
  • build 建立合作关系
  • query 查询合作关系列表

支付有礼

• 功能实现中……

图片上传（营销专用）

• 参见 其它能力

现金红包（基于V2）

• WechatPayRedpackApi 现金红包，通过WechatApiProvider#redpackApi初始化
  • sendRedpack 发放随机红包
  • sendRedpack 发放裂变红包
  • redpackInfo 查询红包信息

重要：基于V2实现，因此需要在配置文件中配置v2支付对应的appSecret参数

资金应用

商家转账到零钱

• WechatBatchTransferApi 商家转账到零钱，通过WechatApiProvider#batchTransferApi初始化
  • batchTransfer 发起批量转账
  • 查询转账批次单
    1. queryBatchByBatchId 通过微信批次单号查询批次单
    2. queryBatchByOutBatchNo 通过商家批次单号查询批次单
  • 查询转账明细单
    1. queryBatchDetailByWechat 通过微信明细单号查询明细单
    2. queryBatchDetailByMch 通过商家明细单号查询明细单
  • 申请转账电子回单
    1. receiptBill 转账账单电子回单申请受理接口
    2. downloadBill 查询转账账单电子回单接口，附带下载能力
  • 申请转账明细电子回单
    1. transferElectronic 受理转账明细电子回单
    2. queryTransferElectronicResult 查询转账账单电子回单接口

分账

• WechatProfitsharingApi 分账，通过WechatApiProvider#profitsharingApi初始化
  • profitsharingOrders 请求分账
  • queryProfitsharingOrder 查询分账结果
  • returnOrders 请求分账回退
  • queryReturnOrders 查询分账回退结果
  • unfreeze 解冻剩余资金
  • queryAmounts 查询剩余待分金额
  • addReceivers 添加分账接收方
  • deleteReceivers 删除分账接收方
  • downloadMerchantBills 申请分账账单

风险合规

消费者投诉2.0

• 功能实现中……

其它能力

清关报关

• 清关报关 暂时没有V3接口，可通过payment spring boot 提供的V2扩展功能自行实现。

媒体上传

包含图片上传和视频上传

• WechatMediaApi 媒体上传，通过WechatApiProvider#mediaApi初始化
  • mediaImageUpload 图片上传
  • mediaVideoUpload 视频上传
  • marketingImageUpload 营销图片上传

通过营销图片上传API上传图片后可获得图片url地址。图片url可在微信支付营销相关的API使用，包括商家券、代金券、支付有礼等。

服务商

施工中……