第三方应用开发 服务端API 企业支付 对外收款 获取对外收款记录
获取对外收款记录
最后更新:2023/11/30
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获取对外收款记录
最后更新:2023/11/30

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

请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalpay/get_bill_list?access_token=ACCESS_TOKEN

请求示例:

{
   "begin_time":1605171726,
   "end_time":1605172726,
   "payee_userid":"zhangshan",
   "cursor":"CURSOR",
   "limit":10
}

参数说明:

参数必须说明
begin_time收款记录开始时间
end_time收款记录结束时间
payee_userid企业收款成员userid,不填则为全部成员
cursor用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填
limit返回的最大记录数,整型,最大值1000

补充说明:

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

权限说明:

  • 只会返回当前在应用可见范围内用户的收款记录
  • 4.1.0及以上版本中新增的部分商户号收款记录,不会返回给第三方应用和代开发应用
  • 调用的应用需要满足如下的权限
    应用类型权限要求
    自建应用配置到「对外收款- 可调用接口的应用」中
    代开发应用具有「对外收款」权限
    第三方应用具有「对外收款」权限

    注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

 

返回结果:

{
	"errcode":0,
	"errmsg":"ok",
	"next_cursor":"CURSOR",
	"bill_list":[
		{
			"transaction_id":"xxxxx",
			"bill_type":1,
			"trade_state":1,
			"pay_time":12345,
			"out_trade_no":"xxxx",
			"out_refund_no":"xxxxx",
			"external_userid":"xxxx",
			"total_fee":100,
			"payee_userid":"zhangshan",
			"payment_type":1,
			"mch_id":"123454",
			"remark":"xxxx",
			"commodity_list":[
				{
					"description":"手机",
					"amount":1
				}
			],
			"total_refund_fee":100,
			"refund_list":[
				{
					"out_refund_no":"xx",
					"refund_userid":"xxx",
					"refund_comment":"xxx",
					"refund_reqtime":1605171790,
					"refund_status":1,
					"refund_fee":100
				}
			],
			"contact_info":{
				"name":"xxx",
				"phone":"xxx",
				"address":"xxx"
			},
			"miniprogram_info":{
				"appid":"xxx",
				"name":"xxx"
			}
		}
	]
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述内容
next_cursor分页游标,在下次请求时填写以获取之后分页的记录,如果已经没有更多的数据则不返回该字段
bill_list交易单详情列表
transaction_id交易单号
bill_type交易类型:
0:收款记录
1:退款记录
trade_state交易状态(退款记录不返回该字段):
1:已完成
3:已完成有退款
pay_time交易时间
out_trade_no商户单号。如果是退款记录,返回对应收款记录的商户单号
out_refund_no退款单号,退款记录返回该字段
external_userid付款人的userid
total_fee收款总金额,单位为分
payee_userid企业内账号userid。退款记录的该字段为退款成员userid,收款记录的该字段为收款成员userid
payment_type收款方式:
0:在聊天中收款
1:收款码收款
2:在直播间收款
3:用产品图册收款
14:转账
15:小程序(仅部分灰度企业可在小程序中接入对外收款账户进行收款)
mch_id收款商户号id
remark备注。退款记录的该字段为退款备注,收款记录的该字段为收款备注
commodity_list商品信息详情列表,商品信息结构参考commodity。退款记录不返回该字段
total_refund_fee退款总金额
refund_list退款单据详情列表,退款单据详情参考refund。退款记录不返回该字段
contact_info联系人信息,详情参考contact,如创建收款项目时设置为不需要联系地址,则该字段为空,第三方不可获取。退款记录不返回该字段
miniprogram_info小程序信息,详情参考miniprogram。收款方式为小程序时返回该字段

商品信息详情(commodity):

参数说明
description商品描述
amount商品数量

退款单据详情(refund):

参数说明
out_refund_no退款单号
refund_userid退款发起人ID
refund_comment退款备注
refund_reqtime退款发起时间
refund_status退款状态:
0:已申请退款
1:退款处理中
2:退款成功
3:退款关闭
4:退款异常
5:审批中
6:审批失败
7:审批取消
refund_fee退款金额

 

联系人信息(contact)(第三方不可获取):

参数说明
name联系人姓名
phone联系人手机号
address联系地址

小程序信息(miniprogram):

参数说明
appid小程序appid
name小程序名称

 

上一篇
概述
下一篇
获取收款项目的商户单号