发起代扣
收藏接口说明
开发者可以使用该接口，在每个扣款周期内发起扣款。
- 仅当签约单在服务中（SERVING）状态可发起代扣。
- 为保证用户体验，避免半夜扣款，每天仅在6:00-22:00的时间内可发起代扣。如有豁免需求，可联系平台客服。
- 每个扣款周期（目前只支持月度扣款），只能有一笔处理中或者扣款成功的代扣单。
- 支持传入扣款金额，传入的金额需不大于周期代扣模板上配置扣款的金额；如未指定扣款金额，默认按照周期代扣模板上配置的金额进行扣款。
- out_pay_order_no 需要保证在小程序内不重复，请勿传入已经在担保支付或交易系统使用过的开发者侧单号。
- 抖音渠道签约的协议，如需平台代发预扣费通知并扣款，请传入platform_pre_notify=1参数，平台会立即进行预通知，并于d+2日发起扣款，如扣费失败，开发者在可扣费期内，可再次调用扣款接口进行重试（无需指定需要平台预通知），如可扣费期结束后，需要再次发起预扣费通知
使用限制
无
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/trade_auth/v1/developer/create_sign_pay/ |
| HTTP Method | POST |
| Scope | trade_auth.developer.cycle |
| 权限要求 | 无 |
请求参数
请求头
access-token必填String
示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例：application/json
固定值"application/json"
Body
auth_order_id必填String
示例："ad7123123123123"
平台侧签约单的单号，长度<=64byte
merchant_uid必填String
示例："7123123123"
开发者自定义收款商户号
限定在小程序绑定的商户号内
out_pay_order_no必填String
示例："out_pay_order_no_1"
开发者侧代扣单的单号，长度<=64byte
expire_secondsInt64
示例：300
代扣超时时间，单位[秒]。不传则默认超时时间为5分钟
最少30秒，不能超过48小时
notify_urlString
示例："https://www.asdasd"
下单结果回调地址，https开头，长度<=512byte
platform_pre_notifyInt32
示例：1
1 委托平台进行预通知 0/不传 开发者自行预通知
（此参数仅对2025年1月及以后申请的模板生效）
total_amountInt64
示例：1000
指定扣款金额（单位：分），不能超过模板配置金额。如果不填，使用模板配置金额进行扣款。
请求示例
curl --location --request POST 'https://open.douyin.com/api/trade_auth/v1/developer/create_sign_pay' \ --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, "merchant_uid": "7123123123", "expire_seconds": 300, "notify_url": "https://www.asdasd", "platform_pre_notify":0 }'
响应参数
Body展开全部子属性
err_msg必填String
示例：success
错误提示
err_no必填Int32
示例：0
错误码
log_id必填String
示例：2023010128382726
抖音开平统一日志id
dataStruct
返回的数据信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "pay_order_id": "ad712312662434" }, "err_no": 0, "err_msg": "success", "log_id": "2022092115392201020812109511046" }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 10000 | 参数错误 | 对照错误提示和接口字段定义，检查对应的参数 |
| 200 | 12001 | 操作过于频繁，请稍后再试 | 请等待2-3秒后，再重试 |
| 200 | 12002 | 您涉及违规操作，暂时无法使用该功能 | 风控策略拦截，请联系运营 |
| 200 | 20000 | 找不到auth_order_id对应订单 | 按以下步骤排查：
|
| 200 | 21046 | 订单收款商户号不合法 | 请检查merchant_uid，仅支持传入小程序已绑定的商户号 |
| 200 | 26003 | 小程序违规，支付能力被封禁 | 支付能力被封禁了，无法发起扣款，请联系运营处理 |
| 200 | 26006 | 商户号与小程序的支付产品不一致 | 商户号未在云直通进件，本期仅支持云直通商户收款 |
| 200 | 26009 | 该小程序未开通支付能力，请先开通支付能力 | 商户号未进件成功，请检查商户号的进件状态 |
| 200 | 32006 | 签约单状态不正确，无法发起代扣 | 只有签约单在服务中时，才支持发起扣款 |
