cn.felord.payment.wechat.v3

类 WechatProfitsharingApi

java.lang.Object

cn.felord.payment.wechat.v3.AbstractApi

cn.felord.payment.wechat.v3.WechatProfitsharingApi

public class WechatProfitsharingApi
extends AbstractApi

微信V3直联商户分账

从以下版本开始:

1.0.11.RELEASE

作者:

felord.cn

构造器概要

构造器

构造器和说明
WechatProfitsharingApi(WechatPayClient wechatPayClient, String tenantId) Instantiates a new Abstract api.

方法概要

限定符和类型	方法和说明
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>	addReceivers(AddReceiversParams addReceiversParams) 添加分账接收方API 商户发起添加分账接收方请求，建立分账接收方列表。
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>	deleteReceivers(DelReceiversParams delReceiversParams) 删除分账接收方API 商户发起删除分账接收方请求。
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>	downloadMerchantBills(ProfitsharingBillParams billParams) 申请分账账单API 微信支付按天提供分账账单文件，商户可以通过该接口获取账单文件的下载地址。
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>	profitsharingOrders(ProfitSharingOrder profitSharingOrder) 请求分账API 微信订单支付成功后，商户发起分账请求，将结算后的资金分到分账接收方 注意： 对同一笔订单最多能发起20次分账请求，每次请求最多分给50个接收方 此接口采用异步处理模式，即在接收到商户请求后，优先受理请求再异步处理，最终的分账结果可以通过查询分账接口获取
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>	queryAmounts(String transactionId) 查询剩余待分金额API 可调用此接口查询订单剩余待分金额
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>	queryProfitsharingOrder(QueryOrderParams queryOrderParams) 查询分账结果API 发起分账请求后，可调用此接口查询分账结果 注意： 发起解冻剩余资金请求后，可调用此接口查询解冻剩余资金的结果
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>	queryReturnOrders(QueryReturnOrderParams queryReturnOrderParams) 查询分账回退结果API 商户需要核实回退结果，可调用此接口查询回退结果 注意： 如果分账回退接口返回状态为处理中，可调用此接口查询回退结果
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>	returnOrders(ReturnOrdersParams returnOrdersParams) 请求分账回退API 如果订单已经分账，在退款时，可以先调此接口，将已分账的资金从分账接收方的账户回退给分账方，再发起退款 注意： 分账回退以原分账单为依据，支持多次回退，申请回退总金额不能超过原分账单分给该接收方的金额 此接口采用同步处理模式，即在接收到商户请求后，会实时返回处理结果 对同一笔分账单最多能发起20次分账回退请求 退款和分账回退没有耦合，分账回退可以先于退款请求，也可以后于退款请求 此功能需要接收方在商户平台-交易中心-分账-分账接收设置下，开启同意分账回退后，才能使用
WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>	unfreeze(UnfreezeParams unfreezeParams) 解冻剩余资金API 不需要进行分账的订单，可直接调用本接口将订单的金额全部解冻给特约商户 注意： 调用分账接口后，需要解冻剩余资金时，调用本接口将剩余的分账金额全部解冻给特约商户 此接口采用异步处理模式，即在接收到商户请求后，优先受理请求再异步处理，最终的分账结果可以通过查询分账接口获取

从类继承的方法 cn.felord.payment.wechat.v3.AbstractApi

billCsvDownload, billResource, client, container, downloadBillResponse, downloadFundFlowBill, downloadTradeBill, Get, Get, getMapper, Patch, Post, Post, tenantId, wechatMetaBean

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

WechatProfitsharingApi

public WechatProfitsharingApi(WechatPayClient wechatPayClient,
                              String tenantId)

Instantiates a new Abstract api.

参数:

wechatPayClient - the wechat pay client

tenantId - the tenant id

方法详细资料

profitsharingOrders

public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> profitsharingOrders(ProfitSharingOrder profitSharingOrder)

请求分账API

微信订单支付成功后，商户发起分账请求，将结算后的资金分到分账接收方

注意：

• 对同一笔订单最多能发起20次分账请求，每次请求最多分给50个接收方
• 此接口采用异步处理模式，即在接收到商户请求后，优先受理请求再异步处理，最终的分账结果可以通过查询分账接口获取

参数:

profitSharingOrder - the profit sharing order

返回:

the wechat response entity

queryProfitsharingOrder

public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> queryProfitsharingOrder(QueryOrderParams queryOrderParams)

查询分账结果API

发起分账请求后，可调用此接口查询分账结果

注意：

• 发起解冻剩余资金请求后，可调用此接口查询解冻剩余资金的结果

参数:

queryOrderParams - the query order params

返回:

the wechat response entity

returnOrders

public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> returnOrders(ReturnOrdersParams returnOrdersParams)

请求分账回退API

如果订单已经分账，在退款时，可以先调此接口，将已分账的资金从分账接收方的账户回退给分账方，再发起退款

注意：

• 分账回退以原分账单为依据，支持多次回退，申请回退总金额不能超过原分账单分给该接收方的金额
• 此接口采用同步处理模式，即在接收到商户请求后，会实时返回处理结果
• 对同一笔分账单最多能发起20次分账回退请求
• 退款和分账回退没有耦合，分账回退可以先于退款请求，也可以后于退款请求
• 此功能需要接收方在商户平台-交易中心-分账-分账接收设置下，开启同意分账回退后，才能使用

参数:

returnOrdersParams - the return orders params

返回:

the wechat response entity

queryReturnOrders

public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> queryReturnOrders(QueryReturnOrderParams queryReturnOrderParams)

查询分账回退结果API

商户需要核实回退结果，可调用此接口查询回退结果

注意：

• 如果分账回退接口返回状态为处理中，可调用此接口查询回退结果

参数:

queryReturnOrderParams - the query return order params

返回:

the wechat response entity

unfreeze

public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> unfreeze(UnfreezeParams unfreezeParams)

解冻剩余资金API

不需要进行分账的订单，可直接调用本接口将订单的金额全部解冻给特约商户

注意：

• 调用分账接口后，需要解冻剩余资金时，调用本接口将剩余的分账金额全部解冻给特约商户
• 此接口采用异步处理模式，即在接收到商户请求后，优先受理请求再异步处理，最终的分账结果可以通过查询分账接口获取

参数:

unfreezeParams - the unfreeze params

返回:

the wechat response entity

queryAmounts

public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> queryAmounts(String transactionId)

查询剩余待分金额API

可调用此接口查询订单剩余待分金额

参数:

transactionId - the transaction id

返回:

the wechat response entity

addReceivers

public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> addReceivers(AddReceiversParams addReceiversParams)

添加分账接收方API

商户发起添加分账接收方请求，建立分账接收方列表。后续可通过发起分账请求，将分账方商户结算后的资金，分到该分账接收方

参数:

addReceiversParams - the add receivers params

返回:

wechat response entity

deleteReceivers

public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> deleteReceivers(DelReceiversParams delReceiversParams)

删除分账接收方API

商户发起删除分账接收方请求。删除后，不支持将分账方商户结算后的资金，分到该分账接收方

参数:

delReceiversParams - the del receivers params

返回:

the wechat response entity

downloadMerchantBills

public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> downloadMerchantBills(ProfitsharingBillParams billParams)

申请分账账单API

微信支付按天提供分账账单文件，商户可以通过该接口获取账单文件的下载地址。详细参考文档 申请分账账单API

返回的下载链接可调用AbstractApi.downloadBillResponse(String, String)下载文件

参数:

billParams - the bill params

返回:

the wechat response entity

从以下版本开始:

1.0.13.RELEASE