快速入门

复制包含安装步骤和该插件完整 Markdown 指南的配置 prompt。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-stripe-terminal`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/stripe-terminal/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

bun add @capgo/capacitor-stripe-terminal
bunx cap sync

导入

import { StripeTerminal } from '@capgo/capacitor-stripe-terminal';

快速入门

import { StripeTerminal } from '@capgo/capacitor-stripe-terminal';

await StripeTerminal.initialize({ isTest: true });

示例：discoverReaders

import { StripeTerminal, TerminalConnectTypes } from '@capgo/capacitor-stripe-terminal';

const result = await StripeTerminal.discoverReaders({ type: TerminalConnectTypes.Simulated });
// The result holds sensitive values: use it without logging it.

示例：setConnectionToken

import { StripeTerminal } from '@capgo/capacitor-stripe-terminal';

await StripeTerminal.setConnectionToken({ token: 'token-123' });

常见坑点

监听器: 在页面卸载时移除句柄。
初始化一次: 在应用启动时运行 setup。
唯一可信来源：信任 src/definitions.ts 在 GitHub 仓库中。

后端要求

Stripe Terminal 需要一个安全的后端端点来创建连接令牌。将该 URL 传递给 initialize().

await StripeTerminal.initialize({
  tokenProviderEndpoint: 'https://api.example.com/stripe/terminal/connection-token',
  isTest: true,
});

await StripeTerminal.discoverReaders({ type: 'tap-to-pay' });

示例应用

git clone https://github.com/Cap-go/capacitor-stripe-terminal.git
cd capacitor-stripe-terminal/example-app
bun install
bun run start

单一事实来源

本页记录了当前公开的 API，来自 Capgo/capacitor-stripe-terminal.