Erste Schritte

Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.

        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.

Installieren

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

Importieren

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

Quickstart

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

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

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

Beispiel: setConnectionToken

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

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

Häufige Stolperfallen

Listener: Handles beim Unmounten von Screens entfernen.
Einmalige Initialisierung: Setup beim App-Bootstrap ausführen.
Single Source of Truth: Vertrauen src/definitions.ts im GitHub Repo.

Backend-Anforderung

Stripe Terminal benötigt einen sicheren Backend-Endpoint, der Connection Tokens erstellt. Übergib diese URL an initialize().

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

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

Beispiel-App

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

Source of Truth

Diese Seite dokumentiert die aktuelle öffentliche API von Cap-go/capacitor-stripe-terminal.