接口说明

可以用该接口查询扣款单状态。

使用限制

无

基本信息

名称	描述
HTTP URL	https://open.douyin.com/api/trade_auth/v1/developer/query_pay_order/
HTTP Method	POST
Scope	trade_auth.developer.trade_pay
权限要求	无

请求参数

请求头

access-token必填String

示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

调用https://open.douyin.com/oauth/client_token/生成的token

content-type必填String

示例：application/json

固定值"application/json"

Body

out_pay_order_noString

示例："out_pay_order_no_1"

扣款单开发者的单号，长度<=64byte，pay_order_id 与 out_pay_order_no 二选一

pay_order_idString

示例："ad712312662434"

调用发起扣款接口后，会得到扣款单平台订单号（pay_order_id），此处查询扣款的接口需要传递该订单号，用来查询对应的订单。（pay_order_id 与 out_pay_order_no （开发者侧生产的订单号）二选一）

请求示例
curl --location --request POST 'https://open.douyin.com/api/trade_auth/v1/developer/query_pay_order' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.xxx' \
--data-raw='{
    "pay_order_id": "ad712312662434",
    "out_pay_order_no": "out_pay_order_no_1"
}'

响应参数

Body展开全部子属性

err_msg必填String

示例：success

错误提示

err_no必填Int32

示例：0

错误码

log_id必填String

示例：2023010128382726

抖音开平统一日志id

dataStruct

返回的数据信息，err_no为0 必填

展开子属性

响应示例
正常响应示例异常响应示例
{
  "data": {
    "app_id": "tt312312313123",
    "auth_order_id": "ad7123123123123",
    "out_pay_order_no": "out_pay_order_no_1",
    "pay_order_id": "ad712312662434",
    "status": "SUCCESS",
    "total_amount": 100,
    "fee_detail_list": {
      "title": "油费",
      "amount": 100,
      "description": "租车产生的油费",
      "quantity": 1
    },
    "pay_channel": 10,
    "channel_pay_id": "TPeqw123123213",
    "pay_time": 1698128528000,
    "merchant_uid": "713123123132",
    "notify_url": "https://www.asdasd"
  },
  "err_no": 0,
  "err_msg": "success",
  "log_id": "2022092115392201020812109511046"
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	10000	参数错误	对照错误提示和接口字段定义，检查对应的参数
200	13000	系统错误	请重试，若多次重试仍然报错，请联系oncall
200	20000	订单不存在	查不到该订单，请检查订单号是否传错

开发者文档

扣款单查询

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

扣款单查询在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

扣款单查询