抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 生活服务商家应用 OpenAPI SDK 总览
  • 接入前准备
  • API接口
  • 通用接口
  • 餐饮
  • 到店餐饮团购解决方案
  • 餐饮在线点单解决方案
  • 餐饮买单解决方案
  • 餐饮买单交易能力
  • 买单配置开通通知Webhook
  • 买单退款申请Webhook
  • 退款成功通知Webhook
  • 商家申请退款
  • 聚合码/点餐买单校验
  • 即送(原随心团)解决方案
  • 大交通
  • 酒旅
  • 综合
  • 能力
  • 历史版本文档(不推荐)
  • 接口说明

    当买单场景为点餐或服务商聚合码时,提供给JSAPI组件,校验是否可以进入抖音买单页进行买单

    使用限制

    SLA:支持的最大QPS:1000;

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/goodlife/v1/paybill/trade/check/
    HTTP Method
    POST
    Scope
    life.capacity.paybill.trade.check
    权限要求

    需申请餐综买单解决方案

    请求参数

    请求头
    access-token必填String
    示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
    content-type必填String
    固定值"application/json"
    Rpc-Transit-Life-AccountString

    来客商户根账户ID

    Body展开全部子属性
    account_id必填String
    必填,抖音侧商家id
    pay_bill_scene必填Enum
    买单场景,1:聚合码买单,2:点餐买单
    展开子属性
    poi_id必填String
    必填,poi_id
    uniq_id必填String

    必填,唯一标识或者三方订单号

    如果用作三方订单号,则与「买单三方创单SPI」中的third_order_id是一个含义

    back_urlString


    买单完成后支付成功后可以跳转的三方应用url;聚合码场景忽略该字段,点餐场景需要传,不传默认跳转到点餐小程序首页

    使用 redirectTo 实现功能,只允许跳转同一应用内的页面,详细可参考文档

    can_use_voucherEnum

    是否可用代金券,1:是,2:否

    默认为1 是

    展开子属性
    external_idString
    服务商聚合码标识
    no_discount_amountInt64
    不可优惠金额,单位分
    no_discount_amount_editableEnum

    不可优惠金额是否可修改,如不可修改,no_discount_amount字段必传,且大于0,默认可修改

    展开子属性
    original_amountInt64
    消费金额,单位:分
    original_amount_editableEnum

    消费金额是否可修改,如不可修改,original_amount字段必传,且大于0

    默认可修改

    展开子属性
    请求示例
    curl --location --request POST 'https://open.douyin.com/goodlife/v1/paybill/trade/check/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"account_id":"8HnJJAIlw1","original_amount":555642054791361876,"can_use_voucher":1,"uniq_id":"KZ9IpjfBaU","original_amount_editable":1,"no_discount_amount_editable":1,"poi_id":"WDIa7NWx0Z","no_discount_amount":5957101520825274965,"external_id":"fsJUJmagvC","back_url":"QCDtUO6zbN","pay_bill_scene":1}'

    响应参数

    Body展开全部子属性
    data必填Struct
    展开子属性
    extra必填Struct
    扩展信息
    展开子属性
    pay_bill_url必填String
    示例:aweme://lynxview/?channel=poi_lynx_trade_pay_bill_create&bundle=template.js&dynamic=1&is_life_poi=1&theme=light&trans_status_bar=1&hide_nav_bar=1&use_gecko_first=1&use_bdx=1&surl=https%3A%2F%2Flf-normal-gr-sourcecdn.bytegecko.com%2Fobj%2Fbyte-gurd-source-gr%2Flife%2Ftrade%2Ffe%2Fpoi_lynx_trade_pay_bill_create%2Ftemplate.js&enable_prefetch=1&enable_code_cache=1&poi_id=7423615774923458595&enter_from=aggregation_code&sale_channel=offline.default.default&client_key=awhxsk4dbkkkrxbh&ext_order_id=abc123&disable_modify_pay_amount=false&buy_amount=101&non_discountable_amount=101&disable_modify_non_discountable_amount=false&disable_voucher=false&source=aggregation_code&ext_schema=http%3A%2F%2Fxxxx.xx

    在小程序中,跳转抖音买单页面的schema

    使用方案:

    在接口返回后将pay_bill_url传给openSchema,示例代码:

    tt.openSchema({ schema: data.pay_bill_url });

    h5_pay_bill_urlString
    示例:https://life.douyin.com/h5/life_web_app_jump?schema=aweme%3A%2F%2Flynxview%2F%3Fchannel%3Dpoi_lynx_trade_pay_bill_create%26bundle%3Dtemplate.js%26dynamic%3D1%26is_life_poi%3D1%26theme%3Dlight%26trans_status_bar%3D1%26hide_nav_bar%3D1%26use_gecko_first%3D1%26use_bdx%3D1%26surl%3Dhttps%253A%252F%252Flf-normal-gr-sourcecdn.bytegecko.com%252Fobj%252Fbyte-gurd-source-gr%252Flife%252Ftrade%252Ffe%252Fpoi_lynx_trade_pay_bill_create%252Ftemplate.js%26enable_prefetch%3D1%26enable_code_cache%3D1%26poi_id%3D7423615774923458595%26enter_from%3Daggregation_code%26sale_channel%3Doffline.default.default%26client_key%3Dawhxsk4dbkkkrxbh%26ext_order_id%3Dabc1236661%26disable_modify_pay_amount%3Dtrue%26buy_amount%3D501%26non_discountable_amount%3D101%26disable_modify_non_discountable_amount%3Dtrue%26disable_voucher%3Dfalse%26source%3Daggregation_code%26ext_schema%3Dhttp%253A%252F%252Fxxxx.xx

    在H5中,跳转抖音买单页面的url 地址

    使用方案:

    在接口返回后将页面重定向或者在新页面打开该地址,示例代码:window.location.href = data.h5_pay_bill_url

    响应示例
    正常响应示例异常响应示例
    { "pay_bill_url": "Yab9ctaVcO", "h5_pay_bill_url": "a29C45LGPX", "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20260924143541B07A6444E9B1E2C044FA", "now": 1790231742 }, "data": { "error_code": 0, "description": "" } }
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    2002100001
    未知错误
    重试接口,重试3次仍报错联系抖音生活服务技术支持
    2002100004
    系统繁忙,此时请开发者稍候再试
    重试接口,重试3次仍报错联系抖音生活服务技术支持
    2002100005
    参数不合法
    请根据接口错误返回信息调整参数
    2002119001
    参数不合法
    请根据接口错误返回信息调整参数
    2002119002
    系统繁忙,请稍候再试
    重试
    2002119003
    请求太过频繁,请稍后再试
    重试
    2002119005
    应用未获商家授权
    联系合作商家在商家后台发起授权,并在服务商后台同意授权
    2002119010
    接口已下线
    接口已下线
    2002190002
    access_token无效
    调用接口重新生成access_token
    2002190004
    应用未获得该能力, 请去https://open.douyin.com/申请
    应用申请接口权限
    2002190008
    access_token过期,请刷新或重新授权
    规范token刷新机制,检查是否有测试环境在同步刷新token
    2003000001
    根据实际业务错误返回
    对照接口文档规范参数并重试
    2005000001
    根据实际业务错误返回
    联系抖音处理
    2005000001
    以实际错误信息为准
    提供log_id联系TS排查