All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.egzosn.pay.common.api.PayService Maven / Gradle / Ivy
package com.egzosn.pay.common.api;
import com.egzosn.pay.common.bean.*;
import com.egzosn.pay.common.exception.PayErrorException;
import com.egzosn.pay.common.http.HttpConfigStorage;
import com.egzosn.pay.common.http.HttpRequestTemplate;
import java.awt.image.BufferedImage;
import java.io.InputStream;
import java.math.BigDecimal;
import java.util.Date;
import java.util.Map;
/**
* 支付服务
*
* @author egan
*
* email [email protected]
* date 2016-5-18 14:09:01
*
*/
public interface PayService {
/**
* 设置支付配置
* @param payConfigStorage 支付配置
* @return 支付服务
*/
PayService setPayConfigStorage(PC payConfigStorage);
/**
* 获取支付配置
*
* @return 支付配置
*/
PC getPayConfigStorage();
/**
* 获取http请求工具
*
* @return http请求工具
*/
HttpRequestTemplate getHttpRequestTemplate();
/**
* 设置 请求工具配置 设置并创建请求模版， 代理请求配置这里是否合理？？，
* @param configStorage http请求配置
* @return 支付服务
*/
PayService setRequestTemplateConfigStorage(HttpConfigStorage configStorage);
/**
* 回调校验
*
* @param params 回调回来的参数集
* @return 签名校验 true通过
*/
boolean verify(Map params);
/**
* 签名校验
*
* @param params 参数集
* @param sign 签名原文
* @return 签名校验 true通过
*/
boolean signVerify(Map params, String sign);
/**
* 支付宝需要,微信是否也需要再次校验来源，进行订单查询
* 校验数据来源
* @param id 业务id, 数据的真实性.
* @return true通过
*/
boolean verifySource(String id);
/**
* 返回创建的订单信息
*
* @param order 支付订单
* @return 订单信息
* @see PayOrder 支付订单信息
*/
Map orderInfo(PayOrder order);
/**
* 创建签名
*
* @param content 需要签名的内容
* @param characterEncoding 字符编码
* @return 签名
*/
String createSign(String content, String characterEncoding);
/**
* 创建签名
*
* @param content 需要签名的内容
* @param characterEncoding 字符编码
* @return 签名
*/
String createSign(Map content, String characterEncoding);
/**
* 将请求参数或者请求流转化为 Map
*
* @param parameterMap 请求参数
* @param is 请求流
* @return 获得回调的请求参数
*/
Map getParameter2Map(Map parameterMap, InputStream is);
/**
* 获取输出消息，用户返回给支付端
*
* @param code 状态
* @param message 消息
* @return 返回输出消息
*/
PayOutMessage getPayOutMessage(String code, String message);
/**
* 获取成功输出消息，用户返回给支付端
* 主要用于拦截器中返回
* @param payMessage 支付回调消息
* @return 返回输出消息
*/
PayOutMessage successPayOutMessage(PayMessage payMessage);
/**
* 获取输出消息，用户返回给支付端, 针对于web端
*
* @param orderInfo 发起支付的订单信息
* @param method 请求方式 "post" "get",
* @return 获取输出消息，用户返回给支付端, 针对于web端
* @see MethodType 请求类型
*/
String buildRequest(Map orderInfo, MethodType method);
/**
* 获取输出二维码，用户返回给支付端,
*
* @param order 发起支付的订单信息
* @return 返回图片信息，支付时需要的
*/
BufferedImage genQrPay(PayOrder order);
/**
* 刷卡付,pos主动扫码付款(条码付)
*
* @param order 发起支付的订单信息
* @return 返回支付结果
*/
Map microPay(PayOrder order);
/**
* 交易查询接口
*
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @return 返回查询回来的结果集，支付方原值返回
*/
Map query(String tradeNo, String outTradeNo);
/**
* 交易查询接口，带处理器
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @param callback 处理器
* @param 返回类型
* @return 返回查询回来的结果集
*/
T query(String tradeNo, String outTradeNo, Callback callback);
/**
* 交易关闭接口
*
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @return 返回支付方交易关闭后的结果
*/
Map close(String tradeNo, String outTradeNo);
/**
* 交易关闭接口
*
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @param callback 处理器
* @param 返回类型
* @return 返回支付方交易关闭后的结果
*/
T close(String tradeNo, String outTradeNo, Callback callback);
/**
* 交易交易撤销
*
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @return 返回支付方交易撤销后的结果
*/
Map cancel(String tradeNo, String outTradeNo);
/**
* 交易交易撤销
*
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @param callback 处理器
* @param 返回类型
* @return 返回支付方交易撤销后的结果
*/
T cancel(String tradeNo, String outTradeNo, Callback callback);
/**
* 申请退款接口
* 废弃
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @param refundAmount 退款金额
* @param totalAmount 总金额
* @return 返回支付方申请退款后的结果
* @see #refund(RefundOrder)
*/
@Deprecated
Map refund(String tradeNo, String outTradeNo, BigDecimal refundAmount, BigDecimal totalAmount);
/**
* 申请退款接口
* 废弃
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @param refundAmount 退款金额
* @param totalAmount 总金额
* @param callback 处理器
* @param 返回类型
* @return 返回支付方申请退款后的结果
* @see #refund(RefundOrder, Callback)
*/
@Deprecated
T refund(String tradeNo, String outTradeNo, BigDecimal refundAmount, BigDecimal totalAmount, Callback callback);
/**
* 申请退款接口
*
* @param refundOrder 退款订单信息
* @return 返回支付方申请退款后的结果
*/
Map refund(RefundOrder refundOrder);
/**
* 申请退款接口
*
* @param refundOrder 退款订单信息
* @param callback 处理器
* @param 返回类型
* @return 返回支付方申请退款后的结果
*/
T refund(RefundOrder refundOrder, Callback callback);
/**
* 查询退款
*
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @return 返回支付方查询退款后的结果
*/
@Deprecated
Map refundquery(String tradeNo, String outTradeNo);
/**
* 查询退款
*
* @param tradeNo 支付平台订单号
* @param outTradeNo 商户单号
* @param callback 处理器
* @param 返回类型
* @return 返回支付方查询退款后的结果
*/
@Deprecated
T refundquery(String tradeNo, String outTradeNo, Callback callback);
/**
* 查询退款
*
* @param refundOrder 退款订单单号信息
* @return 返回支付方查询退款后的结果
*/
Map refundquery(RefundOrder refundOrder);
/**
* 查询退款
*
* @param refundOrder 退款订单信息
* @param callback 处理器
* @param 返回类型
* @return 返回支付方查询退款后的结果
*/
T refundquery(RefundOrder refundOrder, Callback callback);
/**
* 下载对账单
*
* @param billDate 账单时间：日账单格式为yyyy-MM-dd，月账单格式为yyyy-MM。
* @param billType 账单类型，商户通过接口或商户经开放平台授权后其所属服务商通过接口可以获取以下账单类型：trade、signcustomer；trade指商户基于支付宝交易收单的业务账单；signcustomer是指基于商户支付宝余额收入及支出等资金变动的帐务账单；
* @return 返回支付方下载对账单的结果
*/
Map downloadbill(Date billDate, String billType);
/**
* 下载对账单
*
* @param billDate 账单时间：具体请查看对应支付平台
* @param billType 账单类型，具体请查看对应支付平台
* @param callback 处理器
* @param 返回类型
* @return 返回支付方下载对账单的结果
*/
T downloadbill(Date billDate, String billType, Callback callback);
/**
* 通用查询接口
* @param tradeNoOrBillDate 支付平台订单号或者账单类型， 具体请
* 类型为{@link String }或者 {@link Date }，类型须强制限制，类型不对应则抛出异常{@link PayErrorException}
* @param outTradeNoBillType 商户单号或者 账单类型
* @param transactionType 交易类型
* @return 返回支付方对应接口的结果
*/
Map secondaryInterface(Object tradeNoOrBillDate, String outTradeNoBillType, TransactionType transactionType);
/**
* 通用查询接口
*
* @param tradeNoOrBillDate 支付平台订单号或者账单日期， 具体请 类型为{@link String }或者 {@link Date }，类型须强制限制，类型不对应则抛出异常{@link PayErrorException}
*
* @param outTradeNoBillType 商户单号或者 账单类型
* @param transactionType 交易类型
* @param callback 处理器
* @param 返回类型
* @return 返回支付方对应接口的结果
*/
T secondaryInterface(Object tradeNoOrBillDate, String outTradeNoBillType, TransactionType transactionType, Callback callback);
/**
* 转账
* @param order 转账订单
* @return 对应的转账结果
*/
Map transfer(TransferOrder order);
/**
* 转账
* @param order 转账订单
* @param callback 处理器
* @param 返回类型
* @return 对应的转账结果
*/
T transfer(TransferOrder order, Callback callback);
/**
* 转账查询
*
* @param outNo 商户转账订单号
* @param tradeNo 支付平台转账订单号
*
* @return 对应的转账订单
*/
Map transferQuery(String outNo, String tradeNo);
/**
* 转账查询
*
* @param outNo 商户转账订单号
* @param tradeNo 支付平台转账订单号
* @param callback 处理器
* @param 返回类型
* @return 对应的转账订单
*/
T transferQuery(String outNo, String tradeNo, Callback callback);
/**
* 将请求参数或者请求流转化为 Map
*
* @param parameterMap 请求参数
* @param is 请求流
* @return 获得回调响应信息
*/
PayOutMessage payBack(Map parameterMap, InputStream is);
/**
* 设置支付消息处理器,这里用于处理具体的支付业务
* @param handler 消息处理器
* 配合{@link com.egzosn.pay.common.api.PayService#payBack(java.util.Map, java.io.InputStream)}进行使用
*
* 默认使用{@link com.egzosn.pay.common.api.DefaultPayMessageHandler }进行实现
*
*/
void setPayMessageHandler(PayMessageHandler handler);
/**
* 设置支付消息处理器,这里用于处理具体的支付业务
* @param interceptor 消息拦截器
* 配合{@link com.egzosn.pay.common.api.PayService#payBack(java.util.Map, java.io.InputStream)}进行使用
*
* 默认使用{@link com.egzosn.pay.common.api.DefaultPayMessageHandler }进行实现
*
*/
void addPayMessageInterceptor(PayMessageInterceptor interceptor);
}
