埋め込みアカウント登録

デフォルトの controller (コントローラー) プロパティを使用して連結アカウントを作成します。コントローラープロパティについて、詳細はシステムの設計をご覧ください。または、アカウントの type (タイプ) を指定して、連結アカウントを作成することもできます。

アカウントの国を指定するか、アカウントのケイパビリティをリクエストした場合、アカウント所有者は国を変更できません。それ以外の場合は、アカウントのダッシュボードへのアクセス権によって異なります。

• ** Stripe ダッシュボードの全機能:** アカウント登録時に、アカウント所有者は通常の Stripe アカウントへの登録時と同様に、任意の取引国を選択できます。Stripe は、選択された国に基づいて、アカウントのケイパビリティのセットを自動的にリクエストします。
• Express ダッシュボード: アカウント登録時に、アカウント所有者は、プラットフォームのダッシュボードのアカウント登録オプションで設定された国のリストから選択できます。また、これらのオプションを設定して、各国のアカウントにリクエストするデフォルトのケイパビリティを指定することもできます。
• Stripe ダッシュボードなし:Stripe が要件収集を担当する場合、アカウント登録フローではアカウント所有者が任意の取引国を選択できます。それ以外の場合は、カスタムのアカウント登録フローで国を設定し、ケイパビリティをリクエストする必要があります。

curl https://api.stripe.com/v1/accounts \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "controller[fees][payer]"=application \
  -d "controller[losses][payments]"=application \
  -d "controller[stripe_dashboard][type]"=express

レスポンスには ID が含まれており、システム全体で Account を参照する場合はこれを使用します。

ケイパビリティをリクエストする

アカウントの作成時に、必要なケイパビリティの requested プロパティを true に設定することで、ケイパビリティをリクエストできます。Express ダッシュボードにアクセスできるアカウントの場合は、アカウント登録オプションを設定して、アカウントの作成時に特定のケイパビリティを自動的にリクエストすることもできます。

Stripe のアカウント登録 UI は、リクエストされたケイパビリティの要件を自動的に収集します。アカウント登録の負荷を軽減するため、必要なケイパビリティのみをリクエストしてください。

情報を事前入力する

アカウント所有者に関する情報 (氏名、住所、その他の詳細など) を入手している場合、アカウントの作成時または更新時にそれを提供することで、アカウント登録をシンプルにできます。アカウント登録インターフェイスは、アカウント所有者に対して、Connect 利用規約に同意する前に、事前入力された情報を確認するよう求めます。アカウント所有者は、Accounts API を使用して情報を提供した場合でも、その事前入力された情報を利用規約に同意する前に編集することができます。

アカウント登録を行い、プラットフォームから URL が提供されている場合は、アカウントの business_profile.url を事前入力します。ビジネスに URL がない場合には、代わりに business_profile.product_description を事前入力できます。

実装内容をテストする際は、テストデータを使用して、本人確認、事業情報の確認、入金の失敗などのさまざまな結果をシミュレーションできます。

カスタム要件セットを収集する

exclude と only 収集オプションを使用して、特定の要件セットを収集するように埋め込みコンポーネントを設定できます。これにより、特定の要件を収集するカスタムフローを構築し、その他のすべての要件に埋め込みコンポーネントを使用できます。以下に例を示します。

• exclude を使用すると、連結アカウントがコンポーネントを介して指定された要件にアクセスできなくなります。
• only を使用して、連結アカウントがコンポーネントを介して指定された要件にのみアクセスするように制限します。

これらの回収オプションの使用の詳細については、アカウントユーザー登録コンポーネントまたはアカウント管理コンポーネントのマニュアルを参照してください。

プラットフォームは、連結アカウントから必要な情報を事前に (アップフロント) 収集するか、段階的に (インクリメンタル) 収集するかを決定する必要があります。アップフロントアカウント登録ではアカウントの eventually_due 要件を収集しますが、インクリメンタルアカウント登録では currently_due 要件のみを収集します。

アップフロントとインクリメンタルのどちらのアカウント登録を使用するかを決定するには、連結アカウントの所在地とケイパビリティに関する要件を確認してください。Stripe は連結アカウントへの影響を最小限に抑えるように努めていますが、時間の経過とともに要件が変化する可能性があります。

お客様が必要な情報を収集する責任を負う連結アカウントの場合、collection_options パラメーターを使用して、今後の要件の動作をカスタマイズできます。アカウントの将来の要件を収集するには、collection_options.future_requirements を include に設定します。

Stripe の利用規約とプライバシーポリシーは、オンラインのアカウント登録で連結アカウントに提示されます。Stripe の利用規約に同意していない連結アカウントは、アカウント登録の最後の画面で規約を受け入れるように求められます。また、オンラインのアカウント登録のフッターにも、Stripe の利用規約とプライバシーポリシーへのリンクが掲載されています。

プラットフォームが要件の収集を行う連結アカウントに対しては、アカウント登録フローをカスタマイズする追加オプションがあります。以下に概要を示します。

自社で利用規約への同意を管理する

プラットフォームとして、貴社が必要な情報を収集する責任を負う連結アカウントを登録している場合、Stripe のオンラインのアカウント登録コンポーネントではなく、自社のプロセスを使用して利用規約への同意を収集できます。自社のプロセスを使用する場合、アカウント登録の最終画面では、連結アカウントには入力した情報の確認のみが求められます。Stripe の利用規約への同意は貴社で確実に取得する必要があります。

ただし、オンラインのアカウント登録には (フッターなどに) 利用規約へのリンクが表示されます。このリンクを、自社の規約およびプライバシーポリシーへのリンクで置き換えることを選択できます。

利用規約およびプライバシーポリシーへのリンク

Stripe の利用規約とプライバシーポリシーはオンライン登録のいたるところで連結アカウントに提示されます。貴社が要件の収集に責任を負う連結アカウントの場合、これらのリンクを自社の規約とポリシーに置き換えることができます。以下の手順に従って Stripe 利用規約を組み込み、Stripe プライバシーポリシーにリンクします。

連結アカウントの ID と、有効にするコンポーネントとして account_onboarding を指定し、Account Session (アカウントセッション) を作成します。

アカウントセッションを作成する

アカウントセッションの作成時に、components パラメーターで account_onboarding を指定して、アカウント登録を有効にします。

curl https://api.stripe.com/v1/account_sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d account=
"{{CONNECTED_ACCOUNT_ID}}" \
  -d "components[account_onboarding][enabled]"=true

アカウントのユーザ登録コンポーネントを表示する

アカウントセッションを作成して ConnectJS を初期化すると、フロントエンドにアカウント登録コンポーネントを表示できます。

// Include this element in your HTML
const accountOnboarding = stripeConnectInstance.create('account-onboarding');
accountOnboarding.setOnExit(() => {
  console.log('User exited the onboarding flow');
});
container.appendChild(accountOnboarding);

// Optional: make sure to follow our policy instructions above
// accountOnboarding.setFullTermsOfServiceUrl('{{URL}}')
// accountOnboarding.setRecipientTermsOfServiceUrl('{{URL}}')
// accountOnboarding.setPrivacyPolicyUrl('{{URL}}')
// accountOnboarding.setCollectionOptions({
//   fields: 'eventually_due',
//   futureRequirements: 'include',
// })
// accountOnboarding.setOnStepChange((stepChange) => {
//   console.log(`User entered: ${stepChange.step}`);
// });

次のようなユーザー登録機能については、アカウントのユーザー登録を参照してください。

• 分析用の setOnStepChange などのハンドラを関連付ける。
• iOS SDK と Android SDK を使用してモバイルアプリにユーザー登録を埋め込む。
• 規約とプライバシー URL のカスタマイズ。
• 回収オプションを指定しています。

アカウント要件に対する変更をリッスンするようにシステムを設定します。テストトリガーカードを使用して、新しい要件への対応 (および支払いと入金を無効にする方法) をテストできます。

連結アカウントに currently_due または eventually_due の要件がある場合、アカウント登録フローに送り返します。アカウント登録インターフェイスで収集が必要な情報が認識されるため、具体的な要件を特定する必要はありません。たとえば、タイプミスによってアカウント所有者の本人確認ができない場合、アカウント登録で本人確認書類のアップロードが求められます。

Stripe は、連結アカウントに影響する今後の要件の更新について通知します。アカウントの今後の要件を確認することで、この情報を事前に収集できます。

controller.requirement_collection が stripe である連結アカウントの場合は、Account Link (アカウントリンク) または Account Session (アカウントセッション) の作成後に本人確認情報の更新の受信を停止します。

アカウントは、本人確認情報を company ハッシュと individual ハッシュに保存します。

確認エラーを処理する

account.updated イベントをリッスンします。current_deadline が着信したときにアカウントに currently_due フィールドが含まれている場合は、対応する機能が無効になり、そのフィールドが past_due に追加されます。

アカウント登録コンポーネントにアカウントを誘導して、確認要件を修正できるようにします。

Stripe ユーザー認証を無効にする

埋め込みアカウント登録を使用する場合、Stripe ユーザー認証がデフォルトで有効になります。disable_stripe_user_authentication を使用して、この動作を削除できます。

ベストプラクティスとして、2 要素認証または同等のセキュリティ対策を導入することをお勧めします。Custom など、この機能をサポートするアカウント設定では、連結アカウントがマイナス残高を返済できない場合、貴社がそのアカウントに対する責任を負うことになります。