发起扣款
接口说明
在用户使用完服务后,可向用户发起服务过程中的产生的服务费用发起扣款。
- 发起扣款限制
- 租车场景
- 对于同一笔信用单而言,累计发起的扣款金额总和不能大于信用单的押金金额。
- 租物场景
- 对于同一笔信用单而言,当已经有一笔处理中或扣款成功的扣款单时,无法再发起扣款。(同一笔信用单仅允许扣款成功一次)
- 对于用户账户余额不足的情况,平台会尝试持续扣款,保持处理中的情况。长时间未扣款成功,开发者可以尝试联系用户处理。
- out_pay_order_no 请勿传入已经在担保支付或交易系统使用过的开发者侧单号。
使用限制
无
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/trade_auth/v1/developer/create_pay_order/ |
HTTP Method | POST |
Scope | trade_auth.developer.trade_pay |
权限要求 | 无 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Body展开全部子属性
auth_order_id必填String
示例:"ad7123123123123"
信用单平台订单号,长度<=64byte
该字段通过 /api/trade_auth/v1/developer/create_auth_order/ 接口返回的 data.auth_order_id 字段获取
fee_detail_list必填List
扣款付费项目详情,长度不能大于20
展开子属性
out_pay_order_no必填String
示例:"out_pay_order_no_1"
扣款单开发者的单号,长度<=64byte
total_amount必填Int64
示例:100
扣款金额,总的扣款金额不能超过押金,扣款金额须>0
notify_urlString
示例:"https://www.asdasd"
下单结果回调地址,https开头,长度<=512byte
请求示例
curl --location --request POST 'https://open.douyin.com/api/trade_auth/v1/developer/create_pay_order' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.xxx' \ --data-raw='{ "auth_order_id": "ad7123123123123", "out_pay_order_no": "out_pay_order_no_1", "total_amount": 100, "fee_detail_list": [ "title": "油费", "amount": 100, "description": "租车产生的油费", "quantity": 1 ], "notify_url": "https://www.asdasd" }'
响应参数
Body展开全部子属性
err_msg必填String
示例:success
错误提示
err_no必填Int32
示例:0
错误码
log_id必填String
示例:2023010128382726
抖音开平统一日志id
dataStruct
返回的数据信息,err_no为0 必填
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "pay_order_id": "ad712312662434" }, "err_no": 0, "err_msg": "success", "log_id": "2022092115392201020812109511046" }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 10000 | 参数错误 | 对照错误提示和接口字段定义,检查对应的参数 |
200 | 13000 | 系统错误 | 请重试,若多次重试仍然报错,请联系oncall |
200 | 26003 | 小程序违规,支付能力被封禁 | 支付能力被封禁了,无法发起扣款,请联系运营处理 |
200 | 32006 | 信用单状态不正确,无法发起转支付 | 只有信用单在服务中时,才支持发起扣款 |