Premiers pas

Copiez un prompt de configuration avec les étapes d'installation et le guide markdown complet pour ce 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.

Installer

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

Importer

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

Démarrage rapide

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

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

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

Exemple : setConnectionToken

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

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

Erreurs courantes

Écouteurs : supprimez les handles lors du démontage des écrans.
Initialisation unique: exécutez le setup lors du bootstrap de l'app.
Source de vérité: confiance src/definitions.ts dans le repo GitHub.

Prérequis backend

Stripe Terminal nécessite un endpoint backend sécurisé pour créer des tokens de connexion. Transmettez cette URL à initialize().

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

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

Example app

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

Source de vérité

Cette page documente l'actuel API public de Cap-go/capacitor-stripe-terminal.