Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this 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.

Install

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

Import

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

Quick start

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

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

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

Example: setConnectionToken

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

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

Common pitfalls

Listeners: remove handles when screens unmount.
Initialize once: run setup during app bootstrap.
Source of truth: trust src/definitions.ts in the GitHub repo.

Backend requirement

Stripe Terminal requires a secure backend endpoint that creates connection tokens. Pass that URL to 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 Of Truth

This page documents the current public API from Cap-go/capacitor-stripe-terminal.