@capgo/capacitor-stripe-pay

Capacitor plugin for Stripe Payment Sheet, Apple Pay, and Google Pay on iOS and Android. Maintained by Capgo with the latest Stripe SDKs and fixes from the community fork.

Subscriptions: For App Store / Play Store subscriptions, use @capgo/native-purchases instead of this plugin.

Why this plugin

This plugin is a maintained fork of @capacitor-community/stripe. Capgo split the community project into focused packages — each with its own docs, example app, and CI.

We track open issues and pull requests in the community repository, merge relevant fixes into our repos, and ship them on current Stripe SDKs. Our goal is to be more reactive than the community maintainers when bugs land or platforms change.

This package covers Payment Sheet, Apple Pay, and Google Pay.

If you use the community package today, this is the maintained upgrade path from the community package.

Documentation

The most complete documentation is available here: https://capgo.app/docs/plugins/stripe-pay/

Compatibility

| Plugin version | Capacitor compatibility | Maintained | | -------------- | ----------------------- | ---------- | | v8.. | v8.. | ✅ | | v7.. | v7.. | On demand |

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-stripe-pay` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

# Install (choose one)
npm install @capgo/capacitor-stripe-pay
pnpm add @capgo/capacitor-stripe-pay
yarn add @capgo/capacitor-stripe-pay
bun add @capgo/capacitor-stripe-pay

# Then sync Capacitor (choose one)
npx cap sync
pnpm exec cap sync
yarn cap sync
bunx cap sync

Platform setup

1. Create a Stripe account and obtain your publishable key.
2. On your backend, create PaymentIntents or SetupIntents and return the clientSecret to your app.
3. Call Stripe.initialize({ publishableKey }) once at app startup before any other Stripe API.
4. Configure Apple Pay and Google Pay in the Stripe Dashboard and native projects as described in the Capgo docs.

Usage

import { Stripe } from '@capgo/capacitor-stripe-pay';

await Stripe.initialize({ publishableKey: 'pk_test_...' });

await Stripe.createPaymentSheet({
  paymentIntentClientSecret: 'pi_..._secret_...',
  merchantDisplayName: 'My Store',
});

const result = await Stripe.presentPaymentSheet();
console.log(result.paymentResult);

API

• initialize(...)
• handleURLCallback(...)
• Interfaces

initialize(...)

initialize(opts: StripeInitializationOptions) => Promise<void>

| Param | Type | | ---------- | ----------------------------------------------------------------------------------- | | opts | StripeInitializationOptions |

handleURLCallback(...)

handleURLCallback(opts: StripeURLHandlingOptions) => Promise<void>

iOS Only

| Param | Type | | ---------- | ----------------------------------------------------------------------------- | | opts | StripeURLHandlingOptions |

Interfaces

StripeInitializationOptions

| Prop | Type | Description | | -------------------- | ------------------- | ------------------------------------------------- | | publishableKey | string | | | stripeAccount | string | Optional. Making API calls for connected accounts |

StripeURLHandlingOptions

| Prop | Type | | --------- | ------------------- | | url | string |