開発者API

統合 URLスキーム

アプリまたはウェブサイトからStripeのPaymentを起動し、取引を処理します。顧客データ、金額、商品情報を渡して、完了したらコールバックで処理します。

仕組み

アプリが開くと 支払い：// パラメータ付きURL

Stripeの支払いが開始され、取引が処理されます

完了すると、アプリは結果とともにコールバックURLにリダイレクトします。

エンドポイント

チャージを作成する

payment://new?

金額、通貨、説明を入力して 1 回限りの支払いを処理します。

パラメータ

名前	タイプ	必須	説明
`amount`	integer	はい	セント単位の金額（例：1000 = $10.00）
`currency`	string	いいえ	3文字のISO通貨コード（デフォルト：USD）
`description`	string	いいえ	URLエンコードされた料金の説明
`customer`	string	いいえ	既存のStripe顧客ID
`email`	string	いいえ	領収書用の顧客メールアドレス
`name`	string	いいえ	URLエンコードされた顧客名
`metadata`	string	いいえ	カスタムキーと値のペア（URLエンコードされたJSON）
`callback`	string	いいえ	完了後に戻るURL
`autoprocess`	boolean	いいえ	ホーム画面をスキップしてすぐに充電を開始
`auto_return`	boolean	いいえ	販売者が結果ダイアログを閉じるのを待つのではなく、結果が読み込まれた時点でコールバックを実行します。デフォルトはfalseです。

請求書を作成する

payment://cart?

製品カタログの明細項目を含む Stripe 請求書を作成します。

パラメータ

名前	タイプ	必須	説明
`prices`	string	はい	カンマで区切られた価格IDと数量（例：price_abc:2,price_xyz:1）
`customer`	string	いいえ	既存のStripe顧客ID
`email`	string	いいえ	領収書用の顧客メールアドレス
`name`	string	いいえ	URLエンコードされた顧客名
`callback`	string	いいえ	完了後に戻るURL
`auto_return`	boolean	いいえ	販売者が結果ダイアログを閉じるのを待つのではなく、結果が読み込まれた時点でコールバックを実行します。デフォルトはfalseです。

既存の請求書を支払う（iOSのみ）

payment://invoice?

既存のStripe請求書に対して、対面での支払いを受け付けます。金額、通貨、顧客、税金は請求書から取得され、これらのいずれかを上書きしようとすると拒否されます。加盟店はカードリーダー、タップ決済、または手動入力でカードをタップします。支払いが成功すると、請求書は帯域外で支払い済みとしてマークされ、charge_idとpayment_intent_idメタデータによってリンクされます。サブスクリプション、default_payment_method、または未決済ステータスの請求書は、対処可能なエラーとともに拒否されます。

パラメータ

名前	タイプ	必須	説明
`id`	string	はい	Stripe請求書ID（in_で始まる必要があります）
`callback`	string	いいえ	完了後に戻るURL。成功時にはinvoice_idとpayment_intent_idを受け取ります。
`metadata`	string	いいえ	カスタムキーと値のペア（URLエンコードされたJSON）がPaymentIntentメタデータにマージされます
`autoprocess`	boolean	いいえ	ホーム画面をスキップしてすぐに充電を開始します
`auto_return`	boolean	いいえ	販売者が結果ダイアログを閉じるのを待つのではなく、結果が読み込まれた時点でコールバックを実行します。デフォルトはfalseです。

コールバックの処理

取引が完了すると、Stripe 決済機能は結果を示すクエリパラメータとともにコールバック URL にリダイレクトします。デフォルトでは、加盟店が結果ダイアログを閉じた後にリダイレクトが実行され、加盟店は決済後の処理（領収書のメール送信、返金など）を実行できます。結果が判明次第リダイレクトを実行するには、auto_return=true を指定してください。iOS と Android に対応しています。

コールバックパラメータ

パラメータ	価値観	説明
`status`	success \| error \| cancelled	取引の結果
`charge_id`	string	Stripe 請求 ID (成功時)
`invoice_id`	string	Stripe請求書ID（支払い成功時、payment://invoiceフローのみ）
`payment_intent_id`	string	Stripe PaymentIntent ID（成功時、payment://invoice フローのみ）
`error`	string	エラーメッセージ（エラー時）

例

シンプルな料金

金額を入力するだけで10ドルを請求

payment://new?amount=1000

説明付きの料金

説明付きで25.00ユーロを請求

payment://new?amount=2500&currency=eur&description=Coffee%20and%20pastry

新規顧客への請求

50ドルを請求し、顧客レコードを作成します

payment://new?amount=5000&name=John%20Smith&[email protected]

既存顧客に請求

既存のStripe顧客に75.00ドルを請求する

payment://new?amount=7500&customer=cus_ABC123xyz

メタデータで充電

記録用のカスタムメタデータには 100 ドルかかります

payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7D

コールバックによる自動処理

ホーム画面をスキップして、完了したらアプリに戻ります

payment://new?amount=3500&autoprocess=true&callback=myapp://payment-complete

結果の自動返却

販売者が結果ダイアログを閉じるのを待つのではなく、結果が判明したらすぐにコールバックを実行します。

payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-complete

明細項目付き請求書

Stripeカタログの商品を使って請求書を作成する

payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]

既存の請求書を支払う（iOS）

既存のStripe請求書に対する対面での支払いを受け付けます。成功した場合は、invoice_idとpayment_intent_idを返します。

payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paid

完全な例

すべてのパラメータを組み合わせて完全に統合されたフローを実現

payment://new?amount=15000&currency=usd&description=Service%20Fee&customer=cus_ABC123xyz&metadata=%7B%22invoice%22%3A%22INV-2024-001%22%7D&autoprocess=true&callback=myapp://payment-result

URLエンコーディング

パラメータ値内の特殊文字は必ずURLエンコードしてください。スペースは%20、中括弧は%7Bと%7Dになります。

統合する準備はできましたか?

アプリをダウンロードして、今すぐ統合のテストを開始してください。

アプリをダウンロードサポートにお問い合わせください