Skip to main content

Stripe Terminal Capacitor plugin

Capacitor plugin for Stripe Terminal in-person payments.

Install

bun add @capgo/capacitor-stripe-terminal bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-stripe-terminal
  • pnpm add @capgo/capacitor-stripe-terminal
  • yarn add @capgo/capacitor-stripe-terminal

Guide

How to use Stripe Terminal in Capacitor

Using @capgo/capacitor-stripe-terminal

Capacitor plugin for Stripe Terminal in-person payments.

Why Capgo?

Capgo maintains official forks of @capacitor-community/stripe. We monitor upstream issues and pull requests, merge relevant fixes, and ship updates on current Stripe SDKs with example apps and documentation.

If you use the community package today, the Capgo Stripe plugins are the maintained path with faster turnaround on bugs and platform changes.

Install

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

What This Plugin Exposes

  • initialize - Initialize Terminal with a connection token provider endpoint.
  • discoverReaders - Discover Tap to Pay, Bluetooth, or Internet readers.
  • cancelDiscoverReaders - Cancel an in-flight reader discovery session.
  • connectReader - Connect to a discovered reader.

Full Reference

FAQ

Stripe Terminal plugin FAQ

How do I install the Stripe Terminal plugin in a Capacitor app?

Run "bun add @capgo/capacitor-stripe-terminal" (or "npm install @capgo/capacitor-stripe-terminal"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-stripe-terminal" in your app code.

Does @capgo/capacitor-stripe-terminal work with React, Vue and Angular?

Yes. Stripe Terminal is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-stripe-terminal support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-stripe-terminal free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-stripe-terminal/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Stripe Terminal without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Ship Stripe Terminal changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo