支付服务客户端
组件编码
hzero-boot-pay
一、简介
1.1 概述
支付服务接口集成,使用feign调用实现。
1.2 特性
- 基于支付服务实现:hzero-pay
1.3 组件坐标
<dependency>
<groupId>org.hzero.boot</groupId>
<artifactId>hzero-boot-pay</artifactId>
<version>${hzero.boot.version}</version>
</dependency>
二、使用指南
支付客户端使用方法
在代码中自动注入文件客户端:
org.hzero.boot.pay.PayClient
2.1 支付界面
/**
* 跳到支付界面 针对实时支付
*
* @param organizationId 租户ID
* @param channelCode 支付渠道(alipay、wxpay、unionpay)
* @param configCode 配置编码(不传使用默认配置)
* @param paymentOrderNum 支付订单号
*/
public Response toPay(Long organizationId, String channelCode, String configCode, String paymentOrderNum)
2.2 支付
/**
* 获取二维码图像 二维码支付
*
* @param organizationId 租户ID
* @param channelCode 支付渠道(alipay、wxpay、unionpay)
* @param configCode 配置编码(不传使用默认配置)
* @param paymentOrder 支付订单
* @return 二维码图像
*/
public InputStream toQrPay(Long organizationId, String channelCode, String configCode, PaymentOrder paymentOrder)
/**
* 订单数据支付
*
* @param organizationId 租户ID
* @param channelCode 支付渠道(alipay、wxpay、unionpay)
* @param configCode 配置编码(不传使用默认配置)
* @param paymentOrder 支付订单
* @return 支付结果
*/
public ReturnDTO pay(Long organizationId, String channelCode, String configCode, PaymentOrder paymentOrder)
/**
* 刷卡付,pos主动扫码付款(条码付)
*
* @param organizationId 租户ID
* @param channelCode 支付渠道(alipay、wxpay、unionpay)
* @param configCode 配置编码(不传使用默认配置)
* @param paymentOrder 支付订单
* @return 支付结果
*/
public ReturnDTO microPay(Long organizationId, String channelCode, String configCode, PaymentOrder paymentOrder)
2.3 支付/退款查询
/**
* 支付查询
*
* @param organizationId 租户ID
* @param channelCode 支付渠道(alipay、wxpay、unionpay)
* @param configCode 配置编码(不传使用默认配置)
* @param order 订单信息
* @return 返回查询回来的结果集,支付方原值返回
*/
public ReturnDTO query(Long organizationId, String channelCode, String configCode, PayOrderDTO order)
/**
* 查询退款
*
* @param organizationId 租户ID
* @param channelCode 支付渠道(alipay、wxpay、unionpay)
* @param configCode 配置编码(不传使用默认配置)
* @param info 退款信息
* @return 返回支付方查询退款后的结果
*/
public ReturnDTO refundQuery(Long organizationId, String channelCode, String configCode, RefundInfo info)
2.4 交易关闭
/**
* 交易关闭接口
*
* @param organizationId 租户ID
* @param channelCode 支付渠道(alipay、wxpay、unionpay)
* @param configCode 配置编码(不传使用默认配置)
* @param order 订单信息
* @return 返回支付方交易关闭后的结果
*/
public ReturnDTO close(Long organizationId, String channelCode, String configCode, PayOrderDTO order)
2.5 申请退款
/**
* 根据支付订单申请退款
*
* @param organizationId 租户ID
* @param paymentOrderNum 支付订单号
* @return 申请结果
*/
public ReturnDTO refundApply(Long organizationId, String paymentOrderNum)
/**
* 申请退款
*
* @param organizationId 租户ID
* @param channelCode 支付渠道(alipay、wxpay、unionpay)
* @param configCode 配置编码(不传使用默认配置)
* @param info 退款信息
* @return 返回支付方申请退款后的结果
*/
public ReturnDTO refund(Long organizationId, String channelCode, String configCode, RefundInfo info)
2.6 下载账单
/**
* 下载对账单
*
* @param organizationId 租户ID
* @param channelCode 支付渠道(alipay、wxpay、unionpay)
* @param configCode 配置编码(不传使用默认配置)
* @param order 支付订单
* @return 返回支付方下载对账单的结果
*/
public ReturnDTO downloadBill(Long organizationId, String channelCode, String configCode, PayOrderDTO order)
2.7 验签方法
/**
* 统一验签方法
*
* @param params 参数
* @return 验签成功返回 true,验签失败返回 false
*/
public boolean checkSign(Map<String, Object> params)
三、版本更新日志
1.2.0.RELEASE [2019-12-31]
- 初始支付客户端程序版本