埋め込みアカウント登録

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

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

連結アカウントの国が分かっている場合は、アカウントを作成する際にその情報を入力できます。入力しない場合、デフォルトでプラットフォームと同じ国に設定されます。

To request capabilities for your connected account, you can provide that information when you create the account. Stripe’s onboarding UIs automatically collect the requirements for those capabilities. To reduce onboarding effort, request only the capabilities you need. If you omit capabilities, and your connected account has access to the full Stripe Dashboard or the Express Dashboard, capabilities are automatically requested. For accounts with access to the Express dashboard, Stripe-hosted onboarding uses the Configuration settings to request capabilities based on the account’s country.

アカウント所有者に関する情報 (氏名、住所、その他の詳細など) を入手している場合、アカウントの create (作成) または update (更新) 時に、事前に情報を提供することができます。Stripe のホスティング登録では、Connect 利用規約に同意する前に、事前入力された情報を確認するようアカウント所有者に求めます。API を使用して追加情報を提供することにより、メッセージの数が減り、連結アカウントの登録フローが強化されます。

また、ウェブサイトを持たないアカウントを登録する際に、プラットフォームがアカウントに URL を提供している場合は、そのアカウントの business_profile.url を事前入力します。アカウントに URL がない場合は、代わりに business_profile.product_description を事前入力できます。

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

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

アップフロントまたはインクリメンタルのどちらのアカウント登録を使用するかを決定するには、連結アカウントが所在する国で必要な情報を確認して、今後期日を迎える要件を把握してください。Stripe は連結アカウントへの影響を最小限に抑えるように努めていますが、時間の経過につれて要件が変化する可能性があることに留意してください。

貴社が必要な情報を収集する責任を負う連結アカウントの場合、アカウント登録コンポーネントを導入する際に collectionOptions 属性を使用して、今後の要件の動作をカスタマイズできます。

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_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d account=
{{CONNECTED_ACCOUNT_ID}} \
  -d "components[account_onboarding][enabled]"=true \
  -d "components[account_onboarding][features][external_account_collection]"=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.setSkipTermsOfServiceCollection(false)
// accountOnboarding.setCollectionOptions({
//   fields: 'eventually_due',
//   futureRequirements: 'include',
// })
// accountOnboarding.setOnStepChange((stepChange) => {
//   console.log(`User entered: ${stepChange.step}`);
// });

The stepchange object

Every time the connected account navigates from one step to another in the onboarding process, a stepchange object is passed to the step change handler with the following properties.

Restrictions

• The stepchange object is only for analytics.
• Steps can appear in any order and can be repeated.
• Possible step values can change at any time.

Step Values

Each page in onboarding has a unique step name. This step is an exhaustive list of pages the user could see in the onboarding process. These values can change at any time without notice.

Set up your integration to listen for changes to account requirements. You can test handling new requirements (and how they might disable charges and payouts) with the test mode trigger cards.

Based on your application’s verification requirements, send the connected account back through onboarding when it has currently_due or eventually_due requirements. Use these signals to determine when it’s necessary to re-initiate onboarding for a connected account.

You don’t need to worry about determining which requirements are missing. Onboarding collects the necessary information. For example, if there’s a typo preventing verification, onboarding prompts the connected account to upload an identity document (such as a Driver’s License in the United States). If any information is missing, onboarding requests it.

Stripe notifies you about any upcoming requirements updates that affect your connected accounts. You can proactively collect this information by reviewing the future requirements for your accounts.

確認エラーを処理する

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

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