埋め込みアカウント登録

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

If you specify the account’s country or request any capabilities for it, then the account owner can’t change its country. Otherwise, it depends on the account’s Dashboard access:

• Full Stripe Dashboard: During onboarding, the account owner can select any acquiring country, the same as when signing up for a normal Stripe account. Stripe automatically requests a set of capabilities for the account based on the selected country.
• Express Dashboard: During onboarding, the account owner can select from a list of countries that you configure in your platform Dashboard Onboarding options. You can also configure those options to specify the default capabilities to request for accounts in each country.
• No Stripe Dashboard: If Stripe is responsible for collecting requirements, then the onboarding flow lets the account owner select any acquiring country. Otherwise, your custom onboarding flow must set the country and request capabilities.

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

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

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

You can request capabilities when creating an account by setting the desired capabilities’ requested property to true. For accounts with access to the Express Dashboard, you can also configure your Onboarding options to automatically request certain capabilities when creating an account.

Stripe’s onboarding UIs automatically collect the requirements for requested capabilities. To reduce onboarding effort, request only the capabilities you need.

Prefill information

If you have information about the account holder (like their name, address, or other details), you can simplify onboarding by providing it when you create or update the account. The onboarding interface asks the account holder to confirm the pre-filled information before accepting the Connect service agreement.

If you onboard an account and your platform provides it with a URL, prefill the account’s business_profile.url. If the business doesn’t have a URL, you can prefill its business_profile.product_description instead.

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

As the platform, you must decide if you want to collect the required information from your connected accounts up front or incrementally. Up-front onboarding collects the eventually_due requirements for the account, while incremental onboarding only collects the currently_due requirements.

To determine whether to use up-front or incremental onboarding, review the requirements for your connected accounts’ locations and capabilities. While Stripe tries to minimize any impact to connected accounts, requirements might change over time.

For connected accounts where you’re responsible for requirement collection, you can customize the behavior of future requirements using the collection_options parameter. To collect the account’s future requirements, set collection_options.future_requirements to 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.setSkipTermsOfServiceCollection(false)
// accountOnboarding.setCollectionOptions({
//   fields: 'eventually_due',
//   futureRequirements: 'include',
// })
// accountOnboarding.setOnStepChange((stepChange) => {
//   console.log(`User entered: ${stepChange.step}`);
// });

The StepChange object

The StepChange type is defined in connect.js. Every time the connected account navigates from one step to another in the onboarding process, the step change handler receives a StepChange object with the following property:

Step Restrictions

• The StepChange object is only for analytics.
• Steps can appear in any order and can repeat.
• The list of valid step names can change at any time, without notice.

Step Names

Each page in an onboarding flow has one of the following step names.

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 trigger cards.

Send a connected account back through onboarding when it has any currently_due or eventually_due requirements. You don’t need to identify the specific requirements, because the onboarding interface knows what information it needs to collect. For example, if a typo is preventing verification of the account owner’s identity, onboarding prompts them to upload an identity document.

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.

For connected accounts where controller.requirement_collection is stripe, stop receiving updates for identity information after creating an Account Link or Account Session.

Accounts store identity information in the company and individual hashes.

確認エラーを処理する

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

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

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

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

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