cn.felord.api

Interface ExternalCorPayApi

public interface ExternalCorPayApi

对外收款

Since:

2023 /6/29 13:53

Author:

dax

Method Summary

Modifier and Type	Method and Description
BillResponse	getBillList(BillRequest request) 获取对外收款记录
FundFlowResponse	getFundFlow(FundFlowRequest request) 获取资金流水
MchDetailResponse	getMerchant(MchId mchId) 查询商户号详情
GenericResponse<List<OutTradeNo>>	getPaymentInfo(PaymentId paymentId) 获取收款项目的商户单号
WeComResponse	setMchUseScope(MchScopeRequest request) 设置商户号使用范围

Method Detail

getMerchant

@POST(value="externalpay/getmerchant")
MchDetailResponse getMerchant(@Body
                                                                     MchId mchId)

查询商户号详情

通过该接口可以查询已绑定商户号信息以及商户号使用范围

只允许对外收款应用的接口凭证调用该接口

Parameters:

mchId - the mch id

Returns:

the merchant

setMchUseScope

WeComResponse setMchUseScope(@Body
                             MchScopeRequest request)

设置商户号使用范围

通过该接口可以设置已绑定商户号的使用范围

只允许对外收款应用的接口凭证调用该接口

Parameters:

request - the request

Returns:

the mch use scope

getBillList

@POST(value="externalpay/get_bill_list")
BillResponse getBillList(@Body
                                                                  BillRequest request)

获取对外收款记录

企业和服务商可通过此接口获取企业的对外收款记录

补充说明:

• 收款记录的起止时间间隔不能超过1个月。
• 会过滤收款人不在可见范围中的收款记录，因此返回的记录数可能会小于limit设置的最大记录数。
• 如果没有获取到next_cursor，说明已经拉取完所有的数据。

权限说明：

• 允许对外收款应用secret获取的access_token调用
• 第三方应用调用需要企业授权对外收款的权限
• 只会返回当前在应用可见范围内用户的收款记录
• 4.1.0及以上版本中新增的部分商户号收款记录，不会返回给第三方应用和代开发应用

Parameters:

request - the request

Returns:

the bill list

getPaymentInfo

@POST(value="externalpay/get_payment_info")
GenericResponse<List<OutTradeNo>> getPaymentInfo(@Body
                                                                                             PaymentId paymentId)

获取收款项目的商户单号

获取对外收款项目中每笔收款的商户单号

权限说明：

• 应用需具备对外收款权限
• 只允许获取由应用本身创建的收款项目的收款单号列表

Parameters:

paymentId - the payment id

Returns:

the payment info

getFundFlow

@POST(value="externalpay/get_fund_flow")
FundFlowResponse getFundFlow(@Body
                                                                      FundFlowRequest request)

获取资金流水

企业可通过此接口获取企业的资金流水。

补充说明:

• 可以拉取不早于2022年12月1日的资金流水记录，资金流水记录最长保留3年。
• 当日的资金流水会在次日上午11点后生成。
• 资金流水的起止间隔不能超过31天。
• 会过滤操作人不在应用可见范围中的资金流水，因此返回的记录数可能会小于limit设置的最大记录数。
• 如果没有获取到next_cursor，说明已经拉取完所有的数据。

权限说明：

• 仅允许对外收款应用secret获取的access_token调用
• 仅返回在企业微信开通的商户号资金流水

Parameters:

request - the request

Returns:

the fund flow