获取交易账单
收藏
我的收藏接口说明
开发者/服务商可以通过对账单查询接口查询支付、退款、分账、退分账的账单。
- 账单在次日10点启动生成前一天的对账单,建议商户12点后再获取。
- 返佣账单是按月生成,因此商户传入bill_date为YYYYMMDD,则查询是对应bill_date为YYYYMM的返佣账单。
- 年框返佣账单是按季度的第一个月生成,因此商户传入bill_date为YYYYMMDD,则查询是对应bill_date为YYYYMM的年框返佣账单。
- 每月账单一般会在次月 3 号生成,建议商户于次月3号或之后获取对应的月度账单。
- 获取到的文件下载链接过期时间为6小时。
使用限制
接入前,请先查看接入前准备是否完成
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/apps/v3/bills/ |
HTTP Method | POST |
Scope | trade_basic.developer.trade_bill |
权限要求 | 无 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Body
app_id必填String
示例:tt07e3715e98c9aac0
和商户号绑定的 app_id
bill_date必填String
示例:日账单:20220101
月账单:202201
交易完成时间,格式:yyyyMMdd/yyyyMM
bill_type必填String
示例:payment
账单类型
- payment:支付账单
- settle:分账账单
- refund:退款账单
- return:退分账账单
- withdraw:提现账单
- rebate:返佣账单
- annual_rebate:年框返佣账单
merchant_id必填String
示例:79825042568385190840
进件完成返回的商户号,商户号可以从以下方式获取
- 通过接口发起进件方式返回的merchant_id
- 通过进件页面链接[开发者获取小程序收款商户/合作方进件页面,服务商获取小程序收款商户进件页面,服务商获取服务商进件页面,服务商获取合作方进件页面]方式返回的merchant_id
- 通过开发者平台支付能力页面查看商户号
注意:对于支付账单和退款账单类型,如果该字段为空则会返回该小程序下的钻石账单和所有商户号交易账单。
请求示例
{ "app_id":"ttcfdbb96650e33350", "merchant_id":"72217310113805786153", "bill_type":"payment", "bill_date":"202310" }
响应参数
Body展开全部子属性
err_msg必填String
示例:success
错误提示信息
err_no必填Int32
示例:0
状态码 0 代表业务处理成功,具体错误码参见后文错误码章节
log_id必填String
抖音开平统一日志id
dataStruct
返回数据信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "log_id": "20231127170505E79C3B60F4F43F098168", "data": { "bill_list": [ "https://developer.toutiao.com/wsos_v2/wallet_open_bill_v3_file/object/wsos65645946ed864b0a?expire=1701097506&skipCookie=true&timeStamp=1701075906&sign=4993eeeeee3341923574cc9c15cc60f38509b7fe69580f0ddddddd" ] }, "err_msg": "" }
切换单列布局
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 0 | success | 成功 |
200 | 1000 | 参数解析异常,请检查参数格式 | 请查看参数的格式 |
200 | 1006 | post 请求使用 json 传参 | 请将参数改为Json传参,进行重试 |
200 | 2010 | 参数错误 | 请使用正确的参数重新调用 |
200 | 2000 | 账单文件不存在 | 请确认该商户在指定日期是否有账单文件 |
200 | 3203 | 商户号不存在 | 请确认merchant_id,app_id是否正确 |
200 | 4000 | 商户号和小程序/应用ID不对应 | 请确认merchant_id是否为app_id下的商户号 |
200 | 28001008 | access_token过期,请刷新或重新授权 | access_token过期,请根据请求头中token获取方式调用接口重新获取 |
账单样例