获取交易账单
收藏
我的收藏开发者/服务商可以通过对账单查询接口查询支付、退款、分账、退分账的账单。
使用限制
无
接口说明
- 1.账单在次日10点启动生成前一天的对账单,建议商户12点后再获取。
- 2.返佣账单是按月生成,因此商户传入bill_date为YYYYMMDD,则查询是对应bill_date为YYYYMM的返佣账单。
- 3.年框返佣账单是按季度的第一个月生成,因此商户传入bill_date为YYYYMMDD,则查询是对应bill_date为YYYYMM的年框返佣账单。
- 4.每月账单一般会在次月 3 号生成,建议商户于次月3号或之后获取对应的月度账单
基本信息
基本信息 | |
HTTP URL | |
HTTP Method | GET |
接口频次 | 10QPS(商户号merchant_id维度) |
请求头
名称 | 类型 | 必填 | 描述 |
Content-Type | string | 是 | 固定值 "application/json" |
请求参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
bill_date | string | 是 | 8 | 交易完成时间,格式:yyyyMMdd/yyyyMM | 日账单:20220101月账单202201 |
merchant_id | string | 是 | 64 | 商户号 | 79825042568385190840 |
bill_type | string | 是 | 64 | 账单类型,包括 payment:支付账单, settle:分账账单,refund:退款账单,return:退分账账单,withdraw:提现账单,rebate:返佣账单,annual_rebate:年框返佣账单 | payment |
app_id | string | 是 | 64 | 和商户号绑定的 app_id | tt07e3715e98c9aac0 |
thirdparty_id | string | 否 | 64 | 和商户号绑定的 thirdparty_id | 69825042568385190840 |
sign | string | 必选 | 344 | 详见DEMO |
公共响应参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 |
error_no | number | 是 | - | 返回码,详见错误码 |
error_tips | string | 是 | - | 返回码描述,详见错误码描述 |
请求示例
https://developer.toutiao.com/api/apps/bills?merchant_id=68882720803499563550&bill_type=settle&bill_date=20220526&app_id=ttcfdbb96650e33350&sign=dcd355e392b98739a9d15c7a213a8b38
响应参数
当请求成功时,数据以表格形式返回。由 bill_type 决定,目前有支付账单,分账账单,退款账单,退分账账单,提现账单,返佣账单,年框返佣账单。
支付账单:
字段名 | 描述 | 示例值 |
序号 | 账单行数 | 1 |
支付时间 | 指该笔交易的发起支付的时间,格式为yyyy-MM-DD HH:MM:SS | 2022-01-01 10:00:00 |
支付完成时间 | 指该笔交易的支付成功的时间,格式为yyyy-MM-DD HH:MM:SS | 2022-01-01 10:00:00 |
商户号 | 字节小程序商户号 | 70989828933300083644 |
openid | 用户在各个小程序中的唯一标识 | gS3TwR4HCPXuxbqs |
订单号 | 商户传入的该笔订单的商户订单号 | outtradeno001 |
平台订单号 | 字节小程序为该笔订单分配的订单号 | 4200000008201712143733500001 |
渠道订单号 | 渠道为该笔订单分配的订单号 | 50401010122021000000038202001 |
订单金额 | 该笔订单交易金额,单元是元,保留到小数点后2位 | 8.88 |
支付方式 | 实际用户支付方式的类型:支付宝,微信,抖音支付,银行卡 | 银行卡 |
支付状态 | 支付状态枚举值: SUCCESS:成功 | SUCCESS |
下单poiid | 下单时候的poiid(2023-09-01之后账单才有) | 7082385191204816937 |
spu商品名称 | 下单时候的商品名称(2023-09-01之后账单才有) | xx-套餐 |
分账账单:
字段名 | 描述 | 示例值 |
序号 | 账单行数 | 1 |
分账时间 | 指该笔交易的发起分账时间,格式为yyyy-MM-DD HH:MM:SS | 2022-01-01 10:00:00 |
分账完成时间 | 指该笔交易的分账完成时间,格式为yyyy-MM-DD HH:MM:SS | 2022-01-01 11:00:00 |
商户号 | 字节小程序商户号 | 70989828933300083644 |
openId | 用户在各个小程序中的唯一标识 | gS3TwR4HCPXuxbqs |
订单号 | 商户传入的该笔订单的商户订单号 | outtradeno001 |
平台订单号 | 字节小程序为该笔订单分配的订单号 | 4200000008201712143733500001 |
渠道订单号 | 渠道为该笔订单分配的订单号 | 50401010122021000000038202001 |
订单金额 | 该笔订单交易金额,单元是元,保留到小数点后2位 | 8.88 |
支付方式 | 实际用户支付方式的类型:支付宝,微信,银行卡 | 银行卡 |
分账单号 | 商户传入的该笔订单的分账订单号 | outtradeno888 |
分账状态 | 标识该笔明细数据的类型: SUCCESS:成功 | SUCCESS |
分账方和分账金额 | 分账方以及对应的分账金额 | 商户号61915299511876508290-分成金额(分)7942 |
软件服务费1 | 0.08 | |
软件服务费2 | 0.08 | |
抽佣金额 | 0.88 | |
渠道分账单号 | 渠道传入的该笔订单的分账订单号 | 4200000008201712143733500002 |
平台分账单号 | 字节小程序传入的该笔订单的分账订单号 | 50401010122021000000038202001 |
核销poiid | 核销时候的poiid(2023-09-01之后账单才有) | 7082385191204816937 |
spu商品名称 | 下单时候的商品名称(2023-09-01之后账单才有) | xx-套餐 |
delivery_poi_id | 交易下单时的poiid(2024-02-01之后账单有) | 7082385191204816937 |
退款账单:
字段名 | 描述 | 示例值 |
序号 | 账单行数 | 1 |
退款时间 | 指该笔交易发起退款时间,格式为yyyy-MM-DD HH:MM:SS | 2022-01-01 10:00:00 |
商户号 | 字节小程序商户号 | 70989828933300083644 |
openId | 用户在各个小程序中的唯一标识 | gS3TwR4HCPXuxbqs |
订单号 | 商户传入的该笔订单的商户订单号 | outtradeno001 |
渠道订单号 | 渠道为该笔订单分配的订单号 | 50401010122021000000038202001 |
订单金额 | 该笔订单交易金额,单元是元,保留到小数点后2位 | 8.88 |
支付方式 | 实际用户支付方式的类型:支付宝,微信,银行卡 | 银行卡 |
退款类型 | 该笔退款发送的阶段,分账前和分账后二种 | 分账前 |
退款单号 | 商户传入的该笔订单的退款单号 | out_1650893725629 |
平台退款单号 | 字节小程序传入的该笔订单的退款订单号 | 7090534967599663371 |
退款状态 | 标识该笔明细数据的类型: SUCCESS:成功 | SUCCESS |
退款完成时间 | 指该笔交易的退款成功时间,格式为yyyy-MM-DD HH:MM:SS | 2022-01-01 10:01:00 |
退款金额 | 该笔订单退款金额,单元是元,保留到小数点后2位 | 8.88 |
退款模式 | 退款的模式:系统退款,强制退款,虚拟退款 | 系统退款 |
退款出资方 | 退款资金来源:商户出资,平台出资 | 商户出资 |
下单poiid | 下单时候的poiid(2023-09-01之后账单才有) | 7082385191204816937 |
核销poiid | 核销时候的poiid(2023-09-01之后账单才有) | 7082385191204816937 |
spu商品名称 | 下单时候的商品名称(2023-09-01之后账单才有) | xx-套餐 |
退分账单:
字段名 | 描述 | 示例值 |
序号 | 账单行数 | 1 |
退分账时间 | 指该笔交易发起退分账时间,格式为yyyy-MM-DD HH:MM:SS | 2022-01-01 10:00:00 |
订单号 | 商户传入的该笔订单的商户订单号 | outtradeno001 |
商户号 | 字节小程序商户号 | 70989828933300083644 |
openId | 用户在各个小程序中的唯一标识 | gS3TwR4HCPXuxbqs |
订单金额 | 该笔订单交易金额,单元是元,保留到小数点后2位 | 8.88 |
支付方式 | 实际用户支付方式的类型:支付宝,微信,银行卡 | 银行卡 |
分账单号 | 标识该笔明细数据的类型: SUCCESS:成功 | SUCCESS |
分账完成时间 | 指该笔交易退分账完成时间,格式为yyyy-MM-DD HH:MM:SS | 2022-01-02 10:00:00 |
退分账单号 | 商户传入的该笔订单的退分账单号 | MS165270780122336198263 |
平台退分账单号 | 字节小程序传入的该笔订单的退分账订单号 | 7098325749463140613 |
渠道退分账单号 | 渠道传入的该笔订单的退分账订单号 | 401010122021000000038202001 |
退分账方 | 退分账方的字节小程序平台商户号 | 70957210039969241963 |
退分账金额 | 该笔订 单退分账金额,单元是元,保留到小数点后2位 | 0.04 |
退分账完成时间 | 指该笔交易退分账完成时间,格式为yyyy-MM-DD HH:MM:SS | 2022-05-16 21:30:00 |
退分账状态 | 标识该笔明细数据的类型: SUCCESS:成功 | SUCCESS |
退分账说明 | 指该笔交易退分账时说明 | 支付服务费退回 |
提现账单:
字段名 | 描述 | 示例值 |
序号 | 账单行数 | 1 |
小程序 | 字节小程序ID | tt53a7251acc9eb0c401 |
商户号 | 字节小程序商户号 | 70258209527390231420 |
提现请求号 | 商户传入的该笔提现请求的订单号 | 35cc5576-efdd-9296-08434aaca90a |
提现渠道 | 该笔提现订单对应的提现渠道 | 微信支付 |
结算账户 | 该笔提现订单对应的结算账户 | 171152179 |
结算卡名 称 | 该笔提现订单对应的结算银行支行名称 | 中国民生银行股份有限公司南昌县支行 |
提现时间 | 指该笔提现发起时间,格式为yyyy-MM-DD HH:MM:SS | 2022-05-16 21:30:00 |
提现金额 | 该笔订单提现金额,单元是元,保留到小数点后2位 | 8.88 |
提现状态 | 标识该笔提现状态: SUCCESS:成功 | SUCCESS |
返佣账单:
字段名 | 描述 | 示例值 |
序号 | 账单行数 | 1 |
商户号 | 字节小程序商户号 | 70258209527390231420 |
返佣单号 | 字节小程序为该批次返佣生成的返佣单号 | 7116566787457567013 |
返佣总金额 | 该批次返佣的总金额,单元是元,保留到小数点后2位 | 8.88 |
返佣周期 | 该批次返佣对应的返佣周期,格式yyyy-mm | 2022-06 |
返佣类型 | 该批次返佣对应的返佣类型,返佣类型枚举有:标准返佣(指本地生活商户标准返佣),退佣(指支付后结算商户已退款订单退佣) | 标准返佣 |
返佣状态 | 该批次返佣状态 | 结算成功 |
抽佣单号 | 该单笔字节小程序生成的抽佣单号 | 7114750668228806946 |
单笔抽佣金额 | 该单笔订单抽佣金额,单元是元,保留到小数点后2位 | 1.88 |
单笔返佣金额 | 该单笔订单返佣金额,单元是元,保留到小数点后2位 | 0.73 |
抽佣时间 | 指该单笔订单抽佣发起时间,格式为yyyy-MM-DD HH:MM:SS | 2022-05-16 21:30:00 |
年框返佣账单:
字段名 | 描述 | 示例值 |
序号 | 账单行数 | 1 |
商户号 | 字节小程序商户号 | 69720360030915648360 |
返佣单号 | 字节小程序为该批次返佣生成的返佣单号 | 7117247528378075406 |
返佣总金额 | 该批次返佣的总金额,单元是元,保留到小数点后2位 | 0.46 |
返佣周期 | 该批次返佣对应的返佣周期,格式yyyy-mm | 2022-06 |
返佣类型 | 该批次返佣对应的返佣类型,返佣类型枚举有:年框返佣(指本地生活年框商户返佣) | 年框返佣 |
返佣状态 | 该批次返佣状态 | 结算成功 |
累计GMV(万) | 该商户累计的GMV,单位是万元 | 175 |
返佣比例 | 对该商户返佣的百分比 | 60% |
累计抽佣金额(元) | 累计抽佣金额,单元是元,保留到小数点后2位 | 4.76 |
累计返佣金额(元) | 累计返佣金额,单元是元,保留到小数点后2位 | 2.38 |
剩余应返佣金额(元) | 剩余应返佣金额,单元是元,保留到小数点后2位 | 0.46 |
异常示例
{ "err_no": 2010, "err_tips": "end_date is before start_date" }
错误码
错误码err_no | 描述err_tips | 排查建议 |
1000 | 系统错误 | 系统内部异常,请稍后再试 |
1005 | 频率控制,请稍后重试 | 稍后重试 |
2008 | 权限异常 | |
2010 | 参数错误 | 请使用正确的参数重新调用 |
2042 | 小程序appid无效,请检查app_id字段 | 检查app_id字段信息是否有误 |
2047 | 服务商id无效,请检查thirdparty_id字段 | 检查thirdparty_id字段信息是否有误 |
2048 | 未查询到服务商与小程序的授权关系 | 检查服务商与小程序的授权关系 |
7008 | 账单文件不存在 | 请确认该商户在指定日期是否有账单文件 |
账单样例