Accounts v1 を使用して SaaS プラットフォームを構築する

Stripe の公式ライブラリをインストールして、アプリケーションから API にアクセスできるようにします。

# Available as a gem
sudo gem install stripe

# If you use bundler, you can add this line to your Gemfile
gem 'stripe'

ユーザー (売り手またはサービスプロバイダー) がプラットフォームに登録したら、ユーザーの Account (アカウント) (「連結アカウント」と呼ばれる) を作成し、決済を受け付けて売上をユーザーの銀行口座に入金できるようにします。連結アカウントは Stripe の API でユーザーを表し、アカウント登録要件の収集を簡単にして Stripe がユーザーの本人確認を実行できるようにします。ストアビルダーの例では、連結アカウントはオンラインストアを設定するビジネスを表します。

連結アカウントを作成して情報を事前入力する

/v1/accounts API を使用して連結アカウントを作成します。デフォルトの連結アカウントのパラメーターを指定するか、アカウントタイプを指定して、連結アカウントを作成できます。

curl -X POST https://api.stripe.com/v1/accounts \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

連結アカウントの情報をすでに収集している場合は、Account オブジェクトにその情報を事前入力できます。個人情報や事業情報、外部のアカウント情報など、あらゆるアカウント情報を事前に入力できます。

Account を作成したら、relationship.representative を true に設定した Person を作成して、アカウント開設の責任者と、事前に入力したいアカウント情報 (氏名など) を表します。

curl https://api.stripe.com/v1/accounts/
{{ACCOUNT_ID}}
/persons \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d first_name=Jenny \
  -d last_name=Rosen \
  -d "relationship[representative]"=true

Connect アカウント登録で、事前入力された情報が要求されることはありません。ただし、アカウント所有者は Connect 利用規約に同意する前に、事前入力された情報を確認するよう求められます。

実装内容をテストする場合、テストデータを使用してアカウント情報を事前入力します。

アカウントリンクを作成する

以下のパラメーターを使用して Account Links API を呼び出すことで、アカウントリンクを作成できます。

• account
• refresh_url
• return_url
• type = account_onboarding

curl https://api.stripe.com/v1/account_links \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d account=
"{{CONNECTED_ACCOUNT_ID}}" \
  --data-urlencode refresh_url="https://example.com/reauth" \
  --data-urlencode return_url="https://example.com/return" \
  -d type=account_onboarding

ユーザーをアカウントリンク URL にリダイレクトする

Account Links (アカウントリンク) リクエストへのレスポンスには、キー url の値が含まれます。ユーザーをこのリンクにリダイレクトして、処理を進めることができるようにします。Account Links は一時的なものであり、連結アカウントユーザーの個人情報へのアクセスを許可するため、使用できるのは 1 回限りです。この URL にリダイレクトする前に、アプリケーションでユーザーを認証してください。情報の事前入力は、アカウントリンクを生成する前に行う必要があります。アカウントリンクを作成した後は、そのアカウントの情報を読み書きできなくなります。

プラットフォームに戻るユーザーを処理する

Connect アカウント登録では、ユーザーがプラットフォームにリダイレクトされるすべてのケースを処理するために、return_url と refresh_url の両方を渡す必要があります。ユーザーが快適に操作できるようにするには、これらを正しく実装することが重要です。

return_url

ユーザーが Connect アカウント登録フローを完了すると、Stripe はこの URL へのリダイレクトを行います。ただしこれは、すべての情報が収集されたことを意味するものでも、アカウントの要件がすべて満たされたことを意味するものでもありません。ユーザーがフローに正常に入り、そこから正常に出たことのみを意味します。

パラメーターの状態がこの URL を通じて渡されることはありません。ユーザーが return_url にリダイレクトされたら、以下のいずれかを行い、アカウントの details_submitted パラメーターの状態を確認します。

• account.updated Webhook をリッスンする
• Accounts API を呼び出して、返されたオブジェクトを調べる

refresh_url

以下のケースでは、ユーザーが refresh_url にリダイレクトされます。

• リンクの期限が切れている (リンクが作成されてから数分が経過した)
• ユーザーがすでにリンクにアクセスしている (ユーザーがページを更新したか、ブラウザーで戻るボタンまたは進むボタンをクリックした)
• プラットフォームがアカウントにアクセスできなくなった
• アカウントが拒否された

refresh_url はサーバでメソッドをトリガーし、同じパラメータを使用して Account Link (アカウントリンク) を再度呼び出し、シームレスな体験を作成するためにユーザを Connect アカウント登録フローにリダイレクトする必要があります。

アカウント登録を完了していないユーザーを処理する

ユーザーが return_url にリダイレクトされた場合、アカウント登録プロセスを完了していないことがあります。/v1/accounts エンドポイントを使用してユーザーのアカウントを取得し、charges_enabled を確認します。アカウント登録が完全でない場合は、UI プロンプトを表示し、ユーザーが後でアカウント登録を続行できるようにします。ユーザーは、システムで生成された新しいアカウントリンクで本番環境利用の申請を完了できます。ユーザーがアカウント登録プロセスを完了したかどうかを確認するには、アカウントの details_submitted パラメーターの状態をチェックします。

決済手段の設定を表示して、サポートする決済手段を有効にします。カード支払いはデフォルトで有効になっていますが、その他の決済手段は必要に応じて有効または無効にできます。このガイドでは、Bancontact、クレジットカード、EPS、iDEAL、Przelewy24、SEPA ダイレクトデビット、Sofort が有効化されていることを前提としています。

決済フォームを表示する前に、Stripe は通貨、支払い方法の制約、その他のパラメーターを評価し、対応する支払い方法のリストを決定します。購入完了率の向上につながり、通貨と顧客の場所に最も関連性の高い支払い方法が優先的に表示されます。優先度の低い支払い方法は、オーバーフローメニューの下に隠れた状態になります。

Stripe Checkout を決済フォームとして直接ウェブサイトに埋め込むか、ユーザーを Stripe ホストのページにリダイレクトして決済を受け付けます。Checkout は複数の決済手段をサポートし、最も関連性の高いものを自動的に顧客に表示します。Payment Elementを使用して、1 つのフロントエンドの連携で複数の決済手段を受け付けることができます。これは、決済フォームに iframe として埋め込まれる事前構築済みの UI コンポーネントです。

Stripe がオンラインで提供するページ

オンラインフォーム

カスタムフロー

Checkout セッションを作成する クライアント側 サーバー側

Checkout セッションは、ラインアイテム、注文金額と通貨、および受け付け可能な支払い方法など、埋め込み可能な支払いフォームで顧客に表示する内容を制御します。ダイレクト支払いを実行するとき、Checkout では連結アカウントのブランディング設定を使用します。詳細については、ブランディングをカスタマイズするセクションをご覧ください。

デスティネーション支払いや支払いと送金別方式とは異なり、ダイレクト支払いの不審請求の申請に対処する責任は、ユーザー (連結アカウント) が負います。プラットフォームは責任を負いません。

サーバー側で、Stripe API に以下の呼び出しを行います。Checkout セッションを作成したら、レスポンスで返された URL に顧客をリダイレクトします。

Command Line

言語を選択

cURL

Stripe CLI

Ruby

Python

PHP

Java

Node.js

Go

.NET

No results

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d mode=payment \
  -d "line_items[0][price]"=
"{{PRICE_ID}}" \
  -d "line_items[0][quantity]"=1 \
  -d "payment_intent_data[application_fee_amount]"=123 \
  --data-urlencode success_url="https://example.com/success"

• line_items: この引数は、顧客が購入し、オンラインユーザーインターフェイスに表示されるアイテムを表します。
• success_url: この引数は、支払いを完了したユーザーのリダイレクト先を示します。
• Stripe-Account: このヘッダーは、連結アカウントのダイレクト支払いを示します。ダイレクト支払いの場合、連結アカウントは Stripe 手数料、返金、およびチャージバックに対する責任を負います。Checkout では連結アカウントのブランディングが使用されます。これにより、プラットフォームではなく加盟店と直接やり取りしているような印象を顧客に与えることができます。
• (オプション) payment_intent_data[application_fee_amount]: この引数は、プラットフォームが取引から受け取る予定の金額を指定します。連結アカウントで支払いが処理された後に、application_fee_amount がプラットフォームに送金され、連結アカウントの残高から Stripe 手数料が差し引かれます。

支払い後のイベントを処理する サーバー側

支払いが完了すると Stripe は checkout.session.completed イベントを送信します。Webhook を使用してこのイベントを受信し、顧客への注文確認メールの送信、データベースへの売上の記録、配送ワークフローの開始などのアクションを実行します。

クライアントからのコールバックを待つのではなく、これらのイベントをリッスンします。クライアント側では、コールバックの実行前に顧客がブラウザーのウィンドウを閉じたり、アプリケーションを終了したりする可能性があります。また、支払い方法によっては支払いの確定までに 2 ～ 14 日かかることがあります。自社の構築済みのシステムで非同期イベントをリッスンするように設定すると、一度の導入で複数の支払い方法に対応できるようになります。

Checkout で支払いを回収するときは、checkout.session.completed イベントの処理に加えて、以下の 2 つのイベントも処理することをお勧めします。

イベント	説明	次のステップ
checkout.session.completed	顧客が Checkout フォームを送信して、支払いを正常に承認しました。	支払いが成功するか、失敗するかの結果を待ちます。
checkout.session.async_payment_succeeded	顧客の支払いが成功しました。	購入された商品やサービスのフルフィルメントを行います。
checkout.session.async_payment_failed	何らかの理由により支払いが拒否されたか、失敗しました。	顧客にメールで連絡して、新たに注文するように依頼します。

これらのイベントのすべてに、Checkout Session (Checkout セッション) オブジェクトが含まれています。支払いが成功すると、基となる PaymentIntent のステータスが processing から succeeded に変わります。

アカウントを作成し、OAuth を使用して、アカウント作成フローをテストします。いずれかのテストアカウントにログインして支払い方法の設定に移動し、連結アカウントの支払い方法の設定をテストします。テストキーとテストアカウントを使用して、決済フローをテストします。Stripe のテストカードを使用して支払いフローをテストし、さまざまな支払い結果をシミュレーションできます。