Standard アカウントで Connect を使用する
Stripe の「Standard」アカウントは、通常の Stripe アカウントです。アカウント保有者 (お客様のプラットフォームのユーザー) は Stripe との関わりを持ち、ダッシュボードへのログインや自身での請求の処理を行うことができます。
Stripe のサンプルシステムである Kavholm は、Connect アカウント登録を使用して、ユーザーにシームレスなアカウント登録体験を提供する方法を紹介しています。
始める
Connect を初めて使用する場合は、Standard アカウントを使用して連結アカウントによる支払いの受け付けを有効化するをご覧ください。
Standard アカウントで、Connect アカウント登録フローを使用する
Connect の設定ページに移動し、お客様のブランド の、名称、カラー、アイコンを使用してフォームの外観をカスタマイズします。Connect アカウント登録では、この情報は必須です。
/v1/accounts
API を使用して新しいアカウントを作成し、アカウント ID を取得します。アカウントリンクを生成する前に、ユーザの Account オブジェクトに情報を事前入力できます。以下のパラメータを渡す必要があります。type
=standard
注
新規アカウントを作成した後で、アカウントがダッシュボードに表示されることを確認します。
Account Links API を呼び出して、アカウントを登録するリンクを作成します。
お客様自身のプラットフォームのアカウント登録フローで、Account Links によって返された
url
にユーザをリダイレクトします。アカウントのその他の状態を処理し、必要に応じてアカウントを Connect アカウント登録フローにリダイレクトします。
「オプション」: ダッシュボードでプラットフォームプロダクトの設定を使用して、Connect アカウント登録フローに Tax や Climate などの追加の手順を追加することができます。
Standard アカウントの作成と情報の事前入力
Create Account API を使用し、type
を standard
に設定して連結アカウントを作成します。任意の情報を事前入力できますが、少なくとも type
を指定する必要があります。アカウントの国は、デフォルトでプラットフォームと同じ国に設定されており、アカウントはアカウント登録中に選択を確定します。
注
この例では、アカウントの作成時に設定できる一部のフィールドのみが示されています。address
や website_url
など、設定可能なすべてのフィールドの一覧については、Create Account API リファレンスをご覧ください。
連結アカウントの情報をすでに収集している場合、Account オブジェクトに情報を事前入力できます。個人情報、ビジネス情報、外部口座情報など、アカウントに関するどのような情報でも事前入力できます。
Connect アカウント登録で、事前入力された情報が要求されることはありません。ただし、アカウント所有者は Connect 利用規約に同意する前に、事前入力された情報を確認するよう求められます。
実装内容をテストする場合、テストデータを使用してアカウント情報を事前入力します。
アカウントリンクを作成する
以下のパラメータを使用し、Account Links API を呼び出してアカウントリンクを作成できます。
account
: 前のステップで API から返されたアカウント ID を使用しますrefresh_url
return_url
type
=account_onboarding
ユーザをアカウントリンク URL にリダイレクトする
Account Links リクエストへのレスポンスには、キー url
の値が含まれます。ユーザーをこのリンクにリダイレクトして、フローに送ります。Account Links からの URL は、アカウント保有者の個人情報へのアクセスを許可するため、1 度しか使用できません。この URL にリダイレクトする前に、アプリケーションでユーザーを認証してください。Standard アカウントでアカウントリンクを作成した後は、顧客確認 (KYC) 情報の読み取りや書き込みはできなくなります。最初のアカウントリンクを作成する前に、KYC 情報を事前入力してください。
セキュリティのヒント
アカウントリンクの URL をメールやショートメッセージ、またはその他の方法で、プラットフォームのアプリケーション外に送信しないでください。URL は、アプリケーション内で認証済みのアカウント所有者に提供してください。
プラットフォームに戻るユーザを処理する
Connect アカウント登録では、ユーザーをプラットフォームにリダイレクトするすべてのケースを処理するために、return_url
と refresh_url
の両方を渡す必要があります。ユーザーに最高の体験を提供するためには、これらを正しく実装することが重要です。
注
テスト環境では (ローカルホストでテストする場合など)、return_url
と refresh_url
に HTTP を使用できますが、本番環境で使用できるのは HTTPS のみです。本番移行前に、テスト用の URL を HTTPS の URL に入れ替えてください。
return_url
ユーザーが Connect アカウント登録フローを完了すると、Stripe はこの URL へのリダイレクトを行います。これは、すべての情報が収集されたことを意味するものでも、アカウントの要件がすべて満たされたことを意味するものでもありません。ユーザーがフローに正常に入り、そこから正常に出たことを意味するにすぎません。
この URL を通じて状態が渡されることはありません。ユーザーを return_url
にリダイレクトしたら、以下のいずれかを行ってユーザーのアカウントの details_submitted
パラメーターの状態を確認します。
account.updated
Webhook をリッスンする- Account (アカウント) API を呼び出して、返されたオブジェクトを調べる
refresh_url
以下のケースでは、ユーザーは refresh_url
にリダイレクトされます。
- リンクの期限が切れている (リンク作成後、数分が経過した)
- ユーザーがすでにリンクを使用した (ユーザーがページを更新したか、ブラウザーで戻るボタンまたは進むボタンをクリックした)
- お客様のプラットフォームがアカウントにアクセスできなくなった
- このアカウントが拒否されている
refresh_url
はサーバーでメソッドをトリガーして、同じパラメーターを指定して Account Links を再度呼び出し、ユーザーを Connect アカウント登録フローにリダイレクトしてシームレスな操作性を実現します。
アカウント登録を完了していないユーザを処理する
お客様の return_url
にリダイレクトされたユーザーがアカウント登録プロセスを完了していないことがあります。/v1/accounts
エンドポイントを使用してユーザーのアカウントを取得し、charges_enabled
を確認します。アカウント登録が完全でない場合は、UI プロンプトを表示し、ユーザーが後でアカウント登録を続行できるようにします。ユーザーは、新しいアカウントリンク (組み込みによって生成) で本番環境利用の申請を完了できます。アカウントの details_submitted
パラメーターの状態を確認すると、ユーザーがアカウント登録プロセスを完了したかどうかを調べることができます。