@capgo/capacitor-stripe-terminal

概要

Stripe Terminalの対面決済用 Capacitor プラグイン

まずはこちらから initialize() および以下に示すその他のコアメソッド。

プラットフォーム対応

プラットフォーム	サポート	備考
iOSと	はい	ネイティブ
Android	はい	ネイティブ
Web	いいえ	Capacitor.getPlatform() でガード

なぜ Capgo なのか？

これらのプラグインは、以下をフォークしてメンテナンスされています： @capacitor-community/stripe. Capgo は、コミュニティプロジェクトを分割し、各 Stripe 環境に対応したドキュメント、サンプルアプリ、CI を備えた専用パッケージとして提供しています。

Capgo はコミュニティリポジトリのオープンな Issue と Pull Request を追跡し、関連する修正を当社のリポジトリに移植して、現行の Stripe SDK でリリースしています。バグやプラットフォームのアップデートが入った際には、コミュニティのメンテナーより機敏に対応することを目指しています。

Tap to Payや物理リーダーを使用した対面決済には、 @capgo/capacitor-stripe-terminal はコミュニティパッケージからのアップグレードパスとしてメンテナンスされています。

コア機能

• initialize - 接続トークンプロバイダーのエンドポイントを使用してTerminalを初期化します。
• discoverReaders - Tap to Pay、Bluetooth、またはインターネット経由のリーダーを検出します。
• cancelDiscoverReaders - 実行中のリーダー検出セッションをキャンセルします。
• connectReader - 検出されたリーダーに接続します。

公開 API

メソッド	説明
initialize	接続トークンプロバイダーのエンドポイントを使用して、Terminalを初期化します。
discoverReaders	Tap to Pay、Bluetooth、またはインターネット経由のリーダーを検出します。
cancelDiscoverReaders	実行中のリーダー検出セッションをキャンセルします。
connectReader	検出されたリーダーに接続します。
getPluginVersion	ネイティブの Capacitor プラグインのバージョンを取得します。

リファレンス値

これらの値を以下で使用します： TapToPayUxConfiguration.darkMode Tap to Payの設定時に使用します。

Tap To Pay ダークモード

値	ユーザーは以下を確認できます：
SYSTEM	デバイスのシステム外観に合わせます。
DARK	Tap to Payのフローを強制的にダークモードにします。
LIGHT	Tap to Payのフローを強制的にライトモードにします。

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-stripe-terminal.

関連プラグイン

• @capgo/native-purchases App StoreおよびPlay Storeのサブスクリプション用
• @capgo/capacitor-pay Stripe Payment Sheetを使用しない、ウォレット専用のApple Pay / Google Pay用