Custom アカウントの Stripe ホスティング登録

Custom アカウント向けの Connect アカウント登録は、アップフロントアカウント登録やインクリメンタルアカウント登録をサポートしています。アップフロントアカウント登録は、アカウントの eventually_due 要件を収集し、インクリメンタルアカウント登録は currently_due 要件を収集します。それぞれのメリットとデメリットについては、アカウント登録フローのドキュメントをご覧ください。

currently_due 要件は、この特定の時点での確認に必要なユーザ情報のみを要求します。eventually_due 要件には、最終的に収集する必要があるすべての質問が含まれています。

プラットフォームのニーズに基づいて、currently_due または eventually_due を Account Link (アカウントリンク) への呼び出し時の collection_options.fields パラメーターの値として渡します。次にリクエストの例を示します。

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 \
  -d "collection_options[fields]"=eventually_due

Account Link リクエストへのレスポンスには、url キーの値が含まれています。ユーザーをこのリンクにリダイレクトして、フローに合流させます。Account Link の URL は、アカウント所有者の個人情報へのアクセスを許可するため、1 回しか使用できません。この URL にリダイレクトする前に、アプリケーションでユーザーを認証します。入金アカウントの設定から**、プラットフォームが要件収集を担当するアカウントで外部アカウント情報を収集する**を有効にした場合、または treasury ケイパビリティがリクエストされた場合、ユーザーはアカウント登録フローに入る前に Stripe で追加の認証を設定する必要があります。

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

return_url

ユーザが Connect アカウント登録フローを完了するか、フローの任意の時点で後のために保存をクリックすると、Stripe はこの URL へのリダイレクトを発行します。これは、すべての情報が収集されたこと、またはアカウントに未解決の要件がないことを意味しているわけではありません。フローが適切に開始および終了したことを示しているだけです。

この URL を介して状態が渡されることはありません。ユーザーが return_url にリダイレクトされた後、アカウントの requirements 属性の状態を確認します。account.updated Webhook をリッスンするか、Account (アカウント) オブジェクトを取得して、requirements 属性の状態を調べることができます。詳細については、以下のステップ 4 を参照してください。

refresh_url

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

• リンクの期限が切れた (リンク作成後、数分が経過した)
• リンクがすでに使用された (ユーザがページを更新したか、ブラウザで戻るまたは進むボタンをクリックした)。
• リンクが、URL にアクセスしてプレビューを試みる、メッセージングクライアントなどのサードパーティーアプリケーションに共有された。または、多くのクライアントが自動的にリンクにアクセスすることにより、期限切れになった場合。

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

まだ行っていない場合は、アカウント要件の変更をリッスンするように組み込みを設定します。Webhook を使用して行うことをお勧めします。テスト環境トリガーカードを使用して、新しい要件の処理 (および決済と入金を無効にする方法) をテストできます。

今後予定されている要件の更新が連結アカウントに影響する場合は、お知らせいたします。

埋め込みアカウント登録または Stripe ホスティング登録を使用する場合、future requirements (今後の要件) を満たす情報を前もって収集できます。埋め込みアカウント登録の場合は、埋め込みアカウント登録コンポーネントに collectionOptions 属性を含めます。Stripe ホスティング登録の場合は、アカウントリンクを作成する際に collection_options ハッシュを指定します。

アプリケーションの検証ニーズに基づいて、必要に応じてユーザを Connect アカウント登録に送り返し、ステップ 1 で説明した currently_due または eventually_due の要件を満たします。これをユーザをフローに「いつ」戻すかの信号として使用できます。Connect アカウント登録を使用すると、要件が「何か」を心配する必要がなくなることにご留意ください。ユーザを Connect アカウント登録に送り返すと、適切な情報が収集されます。

たとえば、ユーザーが情報を誤って入力して本人確認できない場合、本人確認書類 (アメリカの運転免許証など) の提出を求められる場合があります。このユーザーを Connect アカウント登録に送信すると、本人であることを確認できる書類のアップロードを求めるメッセージがユーザーに表示されます。

これまでに説明してきた Connect アカウント登録の使用方法の大部分は、ユーザーに新しい情報を提供するように促すものでした。Connect アカウント登録は、Account Link (アカウントリンク) の type パラメーターを介してユーザーがすでに提供した情報をユーザー主導で更新することもサポートしています。type は、account_onboarding または account_update の 2 つの値のいずれかを受け入れます。

account_onboarding

type のこの値は、まだ満たされていない要件を入力するためのフォームを提供します。これは、新しいユーザをアカウント登録する場合、または既存のユーザに新しい要件がある場合 (ユーザはすでに十分な情報を提供していたが、お客様が追加の情報を必要とする新しいケイパビリティを要求したときなど) に使用します。この環境でユーザをフォームに送ると、必要な新しい情報のみが収集されます。

account_update

type にこの値を指定すると、アカウントオブジェクトにすでに入力されている属性が表示され、前に入力した情報をユーザーが編集できるようになります。プラットフォームのウェブサイトのアクセスポイントを type=account_update アカウントリンクに指定して、(ユーザーのアドレスに変更があったときなどに) ユーザーが自分で更新できるようにします。「プロフィールの編集」または「本人確認情報の更新」としてリンクをフレーム化することを検討してください。