For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/open/payment/getOrderPayment.md.

getOrderPayment

使用预下单返回的平台交易订单号拉起用户收银台。

支持版本

前端库版本不低于 0.0.28。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

接入准备

前置条件

  • Android:需用户已登录并完成抖音账号绑定,且当前处于前台可见页面
  • iOS:需用户已登录并完成抖音账号绑定

使用说明

直接调用此 API 时,业务只传入 orderId,用于普通支付收银台流程。 豆包平台免密支付应使用 DoubaoPaymentButton,由组件查询当前用户的免密可用状态, 并在用户选择免密支付时携带平台返回的免密支付方式参数;业务不能自行构造该参数。 当账号未绑定、发生换绑或平台判断免密不可用时,应以组件展示的普通支付路径为准。

此 API 成功仅表示收银台已正常拉起并完成前端交互,不代表订单支付成功。 最终支付状态必须以业务服务端查询订单详情的结果或业务服务端收到的支付结果回调为准。

  • 调用会拉起收银台并需要用户交互,请在用户明确触发支付的交互场景中调用;请勿在无用户操作的后台逻辑中调用。

调用方式

异步 API

getOrderPayment(params: GetOrderPaymentParams): Promise<GetOrderPaymentResult>

入参

名称类型必填默认值约束说明
orderIdstring是--平台交易订单号,长度不超过 64 字节。

传入 `requestOrder` 预下单成功后返回的 `orderId`,不要使用业务侧订单号或自行构造的值。

调用示例

import {
  getOrderPayment,
  requestOrder,
  type RequestOrderParams
} from '@doubao-dev/framework/api';

// 业务方自行实现:从业务服务端获取预下单参数和签名;该函数不是 SDK API。
declare function getOrderParamsFromBusinessServer(): Promise<RequestOrderParams>;
// 业务方自行实现:通过业务服务端确认并刷新最终支付状态;该函数不是 SDK API。
declare function refreshOrderStatusFromBusinessServer(orderId: string): Promise<void>;

const orderParams = await getOrderParamsFromBusinessServer();
const { orderId } = await requestOrder(orderParams);
const { logId } = await getOrderPayment({ orderId });

console.log(orderId, logId);
await refreshOrderStatusFromBusinessServer(orderId);

成功返回

名称类型必返说明
logIdstring是用于服务端排查问题的日志 ID。
orderIdstring是本次拉起收银台所使用的平台交易订单号。

返回示例

{
  "orderId": "order-id",
  "logId": "20260519xxxx"
}

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

{
  "errNo": 114,
  "errMsg": "operation cancelled"
}

错误码

errNoerrMsg平台触发条件处理建议
114operation cancelledAndroid用户在收银台中取消了支付操作用户需要时可再次调用 `getOrderPayment` 重新拉起收银台。

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android、iOS
103feature not support当前环境不支持该能力Android、iOS

平台差异

  • Android:需在前台可见的 Activity 中调用,应用退至后台或无有效页面时会返回失败。
  • Android:用户主动取消支付时返回顶层 errNo 114(operation cancelled);iOS 在该场景不返回顶层专属 errNo。