> 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.

# dypay

发起抖音支付流程。

## 扫码预览

![扫码预览 dypay](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fpayment%252Fdypay%252Findex)

## 支持版本

前端库版本不低于 `0.1.0`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 接入准备

### 前置条件

- 调用前需由业务服务端生成合法的支付请求 data

## 使用说明

`data` 应由业务服务端生成，前端不要自行拼装或修改。

支付流程返回不代表最终支付状态，最终结果应以业务服务端查询结果或支付回调为准。

- 调用会进入支付流程，请在用户明确触发支付的交互场景中调用；不要在后台逻辑中自动调用。

## 调用方式

### 异步 API

```typescript
dypay(params: DypayParams): Promise<object>
```

## 入参

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>data</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>支付请求数据。<br><br>该字段应由业务服务端按支付接入协议生成，前端需原样透传。</td></tr>
</tbody>
</table>

## 调用示例

```typescript
import { dypay } from '@doubao-dev/framework/api';

// 业务方自行实现：从业务服务端获取支付请求数据；该函数不是 SDK API。
declare function getDypayDataFromBusinessServer(): Promise<string>;

const data = await getDypayDataFromBusinessServer();
await dypay({ data });
```

## 成功返回

无返回字段。
