com.github.binarywang.wxpay.service

接口 TransferService

所有已知实现类:

TransferServiceImpl

public interface TransferService

商家转账到零钱

作者:

zhongjun created on 2022/6/17

方法概要

限定符和类型	方法和说明
void	closeReservationTransferBatch(String outBatchNo) 关闭预约商家转账批次接口 商户可以通过此接口关闭预约商家转账批次单。
UserConfirmAuthorizationResult	closeUserConfirmAuthorization(String outAuthorizationNo) 解除免确认收款授权API 商户可通过发起授权时传入的 out_authorization_no 主动关闭用户的免确认收款授权。
TransferBillsGetResult	getBillsByOutBillNo(String outBillNo) 2025.1.15 开始新接口 发起商家转账API 请求方式：GET（HTTPS） 请求地址：请求地址 文档地址：商户单号查询转账单API
TransferBillsGetResult	getBillsByTransferBillNo(String transferBillNo) 2025.1.15 开始新接口 微信单号查询转账单API 请求方式：GET（HTTPS） 请求地址：请求地址 文档地址：商户单号查询转账单API
ReservationTransferBatchGetResult	getReservationTransferBatchByOutBatchNo(String outBatchNo, Boolean needQueryDetail, Integer offset, Integer limit, String detailState) 商户预约批次单号查询批次单接口 通过商户预约批次单号查询批量预约商家转账批次单基本信息。
ReservationTransferBatchGetResult	getReservationTransferBatchByReservationBatchNo(String reservationBatchNo, Boolean needQueryDetail, Integer offset, Integer limit, String detailState) 微信预约批次单号查询批次单接口 通过微信预约批次单号查询批量预约商家转账批次单基本信息。
UserAuthorizationStatusResult	getUserAuthorizationStatus(String openid, String transferSceneId) 商户查询用户授权信息接口 商户通过此接口可查询用户是否对商户的商家转账场景进行了授权。
UserConfirmAuthorizationResult	getUserConfirmAuthorizationByOutAuthorizationNo(String outAuthorizationNo, Boolean isDisplayAuthorization) 商户单号查询免确认收款授权结果API 商户可通过发起授权时传入的 out_authorization_no 查询用户是否已经完成免确认收款授权。
ReservationTransferNotifyResult	parseReservationTransferNotifyResult(String notifyData, SignatureHeader header) 解析预约商家转账通知回调结果 预约批次单中的明细单在转账成功或转账失败时，微信会把相关结果信息发送给商户。
TransferBillsNotifyResult	parseTransferBillsNotifyResult(String notifyData, SignatureHeader header) 2025.1.15 开始新接口 解析商家转账结果 详见
TransferNotifyResult	parseTransferNotifyResult(String notifyData, SignatureHeader header) 解析商家转账结果 详见
UserAuthorizationNotifyResult	parseUserAuthorizationNotifyResult(String notifyData, SignatureHeader header) 解析免确认收款授权结果通知 微信支付会把用户确认授权或关闭授权的结果通知到商户在发起授权时传入的 authorization_notify_url。
ReservationTransferBatchResult	reservationTransferBatch(ReservationTransferBatchRequest request) 批量预约商家转账接口 商户可以通过批量预约接口一次发起批量转账请求，最多可以同时向50个用户发起转账。
TransferBatchesResult	transferBatches(TransferBatchesRequest request) 发起商家转账API 请求方式：POST（HTTPS） 请求地址：请求地址 文档地址：发起商家转账API
QueryTransferBatchesResult	transferBatchesBatchId(QueryTransferBatchesRequest request) 微信批次单号查询批次单API 请求方式：GET（HTTPS） 请求地址：请求地址 文档地址：微信批次单号查询批次单API
TransferBatchDetailResult	transferBatchesBatchIdDetail(String batchId, String detailId) 微信明细单号查询明细单API 请求方式：GET（HTTPS） 请求地址：请求地址 文档地址：微信明细单号查询明细单API
QueryTransferBatchesResult	transferBatchesOutBatchNo(QueryTransferBatchesRequest request) 商家批次单号查询批次单API 请求方式：GET（HTTPS） 请求地址：请求地址 文档地址：商家批次单号查询批次单API
TransferBatchDetailResult	transferBatchesOutBatchNoDetail(String outBatchNo, String outDetailNo) 商家明细单号查询明细单API 请求方式：GET（HTTPS） 请求地址：请求地址 文档地址：商家明细单号查询明细单API
TransferBillsResult	transferBills(TransferBillsRequest request) 2025.1.15 开始新接口 发起商家转账API 请求方式：POST（HTTPS） 请求地址：请求地址 文档地址：发起商家转账API
TransferBillsAfterAuthorizationResult	transferBillsAfterAuthorization(TransferBillsAfterAuthorizationRequest request) 用户授权后转账API 该接口与 transferBills(TransferBillsRequest) 都会创建商家转账单， 区别是本接口用于用户已经完成免确认收款授权后的直接转账场景。
PreTransferWithAuthorizationResult	transferBillsWithAuthorization(PreTransferWithAuthorizationRequest request) 发起转账并完成免确认收款授权API 该接口与 transferBills(TransferBillsRequest) 都会创建商家转账单， 区别是本接口可额外携带免确认收款授权信息，在用户确认收款流程中同步引导用户完成授权。
TransferBillsCancelResult	transformBillsCancel(String outBillNo) 2025.1.15 开始新接口 撤销转账API 请求方式：POST（HTTPS） 请求地址：请求地址 文档地址：商户撤销转账API
UserConfirmAuthorizationResult	userConfirmAuthorization(UserConfirmAuthorizationRequest request) 发起免确认收款授权API 该接口只创建免确认收款授权申请，不创建转账单。

方法详细资料

transferBatches

TransferBatchesResult transferBatches(TransferBatchesRequest request)
                               throws WxPayException

 发起商家转账API

 请求方式：POST（HTTPS）
 请求地址：请求地址

 文档地址：发起商家转账API
 

参数:

request - 转账请求参数

返回:

TransferBatchesResult 转账结果

抛出:

WxPayException - .

parseTransferNotifyResult

TransferNotifyResult parseTransferNotifyResult(String notifyData,
                                               SignatureHeader header)
                                        throws WxPayException

解析商家转账结果 详见

参数:

notifyData - 通知数据

header - 通知头部数据，不传则表示不校验头

返回:

the wx transfer notify result

抛出:

WxPayException - the wx pay exception

transferBatchesBatchId

QueryTransferBatchesResult transferBatchesBatchId(QueryTransferBatchesRequest request)
                                           throws WxPayException

 微信批次单号查询批次单API

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：微信批次单号查询批次单API
 

参数:

request - 查询请求参数

返回:

TransferBatchesResult 查询结果

抛出:

WxPayException - .

transferBatchesBatchIdDetail

TransferBatchDetailResult transferBatchesBatchIdDetail(String batchId,
                                                       String detailId)
                                                throws WxPayException

 微信明细单号查询明细单API

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：微信明细单号查询明细单API
 

参数:

batchId - 微信批次单号

detailId - 微信明细单号

返回:

TransferBatchDetailResult 查询结果

抛出:

WxPayException - .

transferBatchesOutBatchNo

QueryTransferBatchesResult transferBatchesOutBatchNo(QueryTransferBatchesRequest request)
                                              throws WxPayException

 商家批次单号查询批次单API

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：商家批次单号查询批次单API
 

参数:

request - 查询请求参数

返回:

TransferBatchesResult 查询结果

抛出:

WxPayException - .

WxPayException - .

transferBatchesOutBatchNoDetail

TransferBatchDetailResult transferBatchesOutBatchNoDetail(String outBatchNo,
                                                          String outDetailNo)
                                                   throws WxPayException

 商家明细单号查询明细单API

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：商家明细单号查询明细单API
 

参数:

outBatchNo - 商家明细单号

outDetailNo - 商家批次单号

返回:

TransferBatchDetailResult 查询结果

抛出:

WxPayException - .

transferBills

TransferBillsResult transferBills(TransferBillsRequest request)
                           throws WxPayException

 2025.1.15 开始新接口 发起商家转账API

 请求方式：POST（HTTPS）
 请求地址：请求地址

 文档地址：发起商家转账API
 

参数:

request - 转账请求参数

返回:

TransferBillsResult 转账结果

抛出:

WxPayException - .

transferBillsWithAuthorization

PreTransferWithAuthorizationResult transferBillsWithAuthorization(PreTransferWithAuthorizationRequest request)
                                                           throws WxPayException

 发起转账并完成免确认收款授权API

 该接口与 transferBills(TransferBillsRequest) 都会创建商家转账单，
 区别是本接口可额外携带免确认收款授权信息，在用户确认收款流程中同步引导用户完成授权。

 请求方式：POST（HTTPS）
 请求地址：请求地址

 文档地址：发起转账并完成免确认收款授权
 

参数:

request - 发起转账并完成免确认收款授权请求参数

返回:

PreTransferWithAuthorizationResult 发起结果

抛出:

WxPayException - .

transferBillsAfterAuthorization

TransferBillsAfterAuthorizationResult transferBillsAfterAuthorization(TransferBillsAfterAuthorizationRequest request)
                                                               throws WxPayException

 用户授权后转账API

 该接口与 transferBills(TransferBillsRequest) 都会创建商家转账单，
 区别是本接口用于用户已经完成免确认收款授权后的直接转账场景。

 请求方式：POST（HTTPS）
 请求地址：请求地址

 文档地址：用户授权后转账
 

参数:

request - 用户授权后转账请求参数

返回:

TransferBillsAfterAuthorizationResult 转账结果

抛出:

WxPayException - .

transformBillsCancel

TransferBillsCancelResult transformBillsCancel(String outBillNo)
                                        throws WxPayException

 2025.1.15 开始新接口 撤销转账API

 请求方式：POST（HTTPS）
 请求地址：请求地址

 文档地址：商户撤销转账API
 

参数:

outBillNo - 【商户单号】 商户系统内部的商家单号，要求此参数只能由数字、大小写字母组成，在商户系统内部唯一

返回:

TransformBillsGetResult 转账单

抛出:

WxPayException - .

getBillsByOutBillNo

TransferBillsGetResult getBillsByOutBillNo(String outBillNo)
                                    throws WxPayException

 2025.1.15 开始新接口 发起商家转账API

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：商户单号查询转账单API
 

参数:

outBillNo - 【商户单号】 商户系统内部的商家单号，要求此参数只能由数字、大小写字母组成，在商户系统内部唯一

返回:

TransformBillsGetResult 转账单

抛出:

WxPayException - .

getBillsByTransferBillNo

TransferBillsGetResult getBillsByTransferBillNo(String transferBillNo)
                                         throws WxPayException

 2025.1.15 开始新接口 微信单号查询转账单API

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：商户单号查询转账单API
 

参数:

transferBillNo - 【微信转账单号】 微信转账单号，微信商家转账系统返回的唯一标识

返回:

TransformBillsGetResult 转账单

抛出:

WxPayException - .

parseTransferBillsNotifyResult

TransferBillsNotifyResult parseTransferBillsNotifyResult(String notifyData,
                                                         SignatureHeader header)
                                                  throws WxPayException

2025.1.15 开始新接口 解析商家转账结果 详见

参数:

notifyData - 通知数据

header - 通知头部数据，不传则表示不校验头

返回:

the wx transfer notify result

抛出:

WxPayException - the wx pay exception

userConfirmAuthorization

UserConfirmAuthorizationResult userConfirmAuthorization(UserConfirmAuthorizationRequest request)
                                                 throws WxPayException

 发起免确认收款授权API

 该接口只创建免确认收款授权申请，不创建转账单。接口返回的 package_info
 需要用于 JSAPI/APP 调起用户授权页面。

 请求方式：POST（HTTPS）
 请求地址：请求地址

 文档地址：发起免确认收款授权
 

参数:

request - 发起免确认收款授权请求参数

返回:

UserConfirmAuthorizationResult 授权申请结果

抛出:

WxPayException - .

getUserConfirmAuthorizationByOutAuthorizationNo

UserConfirmAuthorizationResult getUserConfirmAuthorizationByOutAuthorizationNo(String outAuthorizationNo,
                                                                               Boolean isDisplayAuthorization)
                                                                        throws WxPayException

 商户单号查询免确认收款授权结果API

 商户可通过发起授权时传入的 out_authorization_no 查询用户是否已经完成免确认收款授权。
 当返回 state 为 TAKING_EFFECT 时，表示授权生效中，可用于用户授权后转账。

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：商户单号查询授权结果
 

参数:

outAuthorizationNo - 商户侧授权单号

isDisplayAuthorization - 是否返回用于调起授权页面的 package_info

返回:

UserConfirmAuthorizationResult 授权结果

抛出:

WxPayException - .

closeUserConfirmAuthorization

UserConfirmAuthorizationResult closeUserConfirmAuthorization(String outAuthorizationNo)
                                                      throws WxPayException

 解除免确认收款授权API

 商户可通过发起授权时传入的 out_authorization_no 主动关闭用户的免确认收款授权。

 请求方式：POST（HTTPS）
 请求地址：请求地址

 文档地址：解除免确认收款授权
 

参数:

outAuthorizationNo - 商户侧授权单号

返回:

UserConfirmAuthorizationResult 解除授权结果

抛出:

WxPayException - .

parseUserAuthorizationNotifyResult

UserAuthorizationNotifyResult parseUserAuthorizationNotifyResult(String notifyData,
                                                                 SignatureHeader header)
                                                          throws WxPayException

 解析免确认收款授权结果通知

 微信支付会把用户确认授权或关闭授权的结果通知到商户在发起授权时传入的 authorization_notify_url。
 通知报文中的 resource 为 AES-256-GCM 加密内容，本方法会完成签名校验（传入 header 时）和资源解密。

 文档地址：免确认收款授权结果通知
 

参数:

notifyData - 通知数据

header - 通知头部数据，不传则表示不校验头

返回:

UserAuthorizationNotifyResult 授权通知结果

抛出:

WxPayException - .

getUserAuthorizationStatus

UserAuthorizationStatusResult getUserAuthorizationStatus(String openid,
                                                         String transferSceneId)
                                                  throws WxPayException

 商户查询用户授权信息接口

 商户通过此接口可查询用户是否对商户的商家转账场景进行了授权。

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：商户查询用户授权信息
 

参数:

openid - 用户在直连商户应用下的用户标识

transferSceneId - 转账场景ID

返回:

UserAuthorizationStatusResult 用户授权信息

抛出:

WxPayException - .

reservationTransferBatch

ReservationTransferBatchResult reservationTransferBatch(ReservationTransferBatchRequest request)
                                                 throws WxPayException

 批量预约商家转账接口

 商户可以通过批量预约接口一次发起批量转账请求，最多可以同时向50个用户发起转账。
 批量预约接口适用于用户已授权免确认的场景，在转账时无需用户确认即可完成转账。

 请求方式：POST（HTTPS）
 请求地址：请求地址

 文档地址：批量预约商家转账
 

参数:

request - 批量预约商家转账请求参数

返回:

ReservationTransferBatchResult 批量预约商家转账结果

抛出:

WxPayException - .

getReservationTransferBatchByOutBatchNo

ReservationTransferBatchGetResult getReservationTransferBatchByOutBatchNo(String outBatchNo,
                                                                          Boolean needQueryDetail,
                                                                          Integer offset,
                                                                          Integer limit,
                                                                          String detailState)
                                                                   throws WxPayException

 商户预约批次单号查询批次单接口

 通过商户预约批次单号查询批量预约商家转账批次单基本信息。

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：商户预约批次单号查询批次单
 

参数:

outBatchNo - 商户预约批次单号

needQueryDetail - 是否需要查询明细

offset - 分页偏移量

limit - 分页大小

detailState - 明细状态（PROCESSING/SUCCESS/FAIL）

返回:

ReservationTransferBatchGetResult 批量预约商家转账批次查询结果

抛出:

WxPayException - .

getReservationTransferBatchByReservationBatchNo

ReservationTransferBatchGetResult getReservationTransferBatchByReservationBatchNo(String reservationBatchNo,
                                                                                  Boolean needQueryDetail,
                                                                                  Integer offset,
                                                                                  Integer limit,
                                                                                  String detailState)
                                                                           throws WxPayException

 微信预约批次单号查询批次单接口

 通过微信预约批次单号查询批量预约商家转账批次单基本信息。

 请求方式：GET（HTTPS）
 请求地址：请求地址

 文档地址：微信预约批次单号查询批次单
 

参数:

reservationBatchNo - 微信预约批次单号

needQueryDetail - 是否需要查询明细

offset - 分页偏移量

limit - 分页大小

detailState - 明细状态（PROCESSING/SUCCESS/FAIL）

返回:

ReservationTransferBatchGetResult 批量预约商家转账批次查询结果

抛出:

WxPayException - .

parseReservationTransferNotifyResult

ReservationTransferNotifyResult parseReservationTransferNotifyResult(String notifyData,
                                                                     SignatureHeader header)
                                                              throws WxPayException

 解析预约商家转账通知回调结果

 预约批次单中的明细单在转账成功或转账失败时，微信会把相关结果信息发送给商户。

 文档地址：预约商家转账通知
 

参数:

notifyData - 通知数据

header - 通知头部数据，不传则表示不校验头

返回:

ReservationTransferNotifyResult 预约商家转账通知结果

抛出:

WxPayException - the wx pay exception

closeReservationTransferBatch

void closeReservationTransferBatch(String outBatchNo)
                            throws WxPayException

 关闭预约商家转账批次接口

 商户可以通过此接口关闭预约商家转账批次单。关闭后，该批次内所有未成功的转账将被取消。

 请求方式：POST（HTTPS）
 请求地址：请求地址

 文档地址：关闭预约商家转账批次
 

参数:

outBatchNo - 商户预约批次单号

抛出:

WxPayException - .