カスタムの Capital プログラムを構築する非公開プレビュー
API を実装してカスタムの Capital プログラムを構築します。
Stripe Capital を使用すると、プラットフォームは連結アカウント向けの事前資格認定型の融資オファーを取得し、規制に準拠したローンアプリケーションを公開し、進行中の融資に関する継続的なレポートを提供できます。
このガイドでは、Connect を使用するプラットフォームが Capital API を導入する方法の概要を説明します。
Capital のライフサイクル
このプログラムを開始するには、プラットフォームが Capital のライフサイクルの以下の 3 つのフェーズに対応可能である必要があります。
- 対象のユーザーに融資オファーを勧める。
- 進行中の融資に対する融資レポートページへのアクセスを提供する。
- ユーザーが融資を完済した後も融資レポートページへのアクセス提供を継続する。
このガイドでは以下の方法について説明します。
- 対象ユーザーの融資オファーを取得します。
- ユーザーが融資の申し込みを利用できるようにします。
- ユーザーに融資レポートページへのアクセスを提供します。
ブランディング設定を確認するダッシュボード
Capital オファーを受け取るすべてのユーザー向けのオファーメール、申請、融資レポートページに、お客様のビジネス名、アイコン、ロゴ、ブランドカラーが表示されます。
**Connect ブランディング設定**に移動し、プラットフォームのブランディング設定が正しいことを確認します。
テスト環境で未提供の融資オファーを作成するダッシュボード
テスト環境のツールを使用して実装を構築することをお勧めします。テスト環境で Capital ダッシュボードに移動します。
- 作成をクリックして、融資オファーを作成モーダルを開きます。ここではテスト環境で融資オファーを作成できます。デフォルトのオプションでは、1,000 USD のローン金額で未提供の融資オファーを作成します。
- デフォルトのオプションをそのままにして融資オファーを作成をクリックします。
- ダッシュボードで、作成したオファーに対応する行をクリックします。
連結アカウントの詳細ページの融資と資金調達セクションに、ユーザーの融資オファーの詳細が表示されます。
融資オファーを取得するサーバー側
List financing offers (融資オファーの一覧表示) エンドポイントを使用して、プラットフォームユーザーすべての融資オファーを取得できます。
オファーが正常に作成されると、次のようなレスポンスが返されます。
{ "object": "list", "url": "/v1/capital/financing_offers", "has_more": false, "data": [ { "id": "financingoffer_abc123", "object": "capital.financing_offer", ..., }, {...} ] }
Retrieve financing offer (融資オファーの取得) エンドポイントを使用して、融資オファーを確認できます。上記の一覧から最初の融資オファーを取得します。
オファーメールを送信サーバー側
融資オファーが作成されると、Stripe は capital.
Webhook を送信します。Webhook の実装を更新して、capital.
Webhook をリッスンします。自社でカスタマイズしたメールを送信している場合、Webhook はユーザーにオファーを通知する重要な通知になります。
警告
マーケティングガイダンスページを確認して、オファーメールの内容がバンキング規制に準拠していることをご確認ください。ユーザー向けの資料に対する変更はすべて、capital-review@stripe.com に提出して審査を受ける必要があります。
メールでは、ユーザーにプラットフォームダッシュボードの専用の Capital セクションへのリンクを提供します。ユーザーは Account Links を使用して Capital の融資申し込みにアクセスします。 Account Links は生成後、短時間で期限切れになるため、申し込みのリンクを再生成する方法をユーザーに提供します。タイプ capital_
の Account Link を生成して、プラットフォームのダッシュボードに融資申し込みへのリンクを含めます。
Account Link が正常に作成されると、次のようなレスポンスが返されます。
{ "object": "account_link", "created": 1611264596, "expires_at": 1611264896, "url": "https://connect.stripe.com/capital/offer/SrjgLUfa0O7K" }
Webhook の実装を更新した後に、ダッシュボードで新たにオファーを作成し、capital.
Webhook が届くことを確認します。
オファーを提供済みとしてマークする
オファーのメールを送信してから、Webhook の実装を更新して、融資を提供済みとしてマークします。オファーを提供済みとしてマークすることは必須であり、オファーをユーザーに提供したという確認になります。
ダッシュボードまたは Financing Offer API を使用して、融資オファーのステータスが提供済みになっていることを確認します。
ステータスの変化をリッスンするサーバー側
capital.
Webhook に加え、融資オファーが別のステータスに移行するたびに、Stripe はさらに Webhook を送信します。受信する可能性がある Webhook の詳細な一覧を次に紹介します。
Webhook の識別子 | トリガー |
---|---|
capital. | 融資オファーが作成された |
capital. | ユーザーがオファーの申し込みを提出した |
capital. | Stripe がオファーの申し込みを承認し、資金がユーザーに入金された |
capital. | ユーザーが融資残高を完済した |
capital. | ユーザーが融資オファーをキャンセルした |
capital. | ユーザーの申し込みが却下された |
capital. | 融資オファーの期限が切れ、申し込みの対象外になった |
capital. | 融資オファーが新しいオファーに更新された |
ダッシュボードで、過去に提供したオファーを探します。
- オーバーフローメニュー () をクリックします。
- オファーを期限切れにするオプションをクリックすると、オファーの期限切れをシミュレーションできます。
capital.
Webhook が届くことを確認します。financing_ offer. expired
テスト環境のツールを使用すると、capital.
以外のすべての Webhook をシミュレーションできます。
オファーに申し込むダッシュボードサーバー側
オファーへの申し込みを行うと、capital.
Webhook をシミュレーションすることができます。
- ダッシュボードから、最大ローン額 20,000 USD のオファーを作成し、提供済みにします。
- タイプ
capital_
のアカウントリンクを生成して、そのリンクに移動します。そこで申請がどのようにユーザーに表示されるかをプレビューできます。financing_ offer - 申し込みの最後に到達するまで続け、送信をクリックします。
capital.
Webhook が届くことを確認します。financing_ offer. accepted - ダッシュボードでオファーを表示し、ステータスが受け付け済みであることを確認します。
申し込みのトラッカーを表示する
ステータスが受け付け済みの融資オファーは、Stripe のサービスチームによる審査を待っています。 この審査の実行中にユーザーを融資レポートページに転送することができます。融資レポートページには、申し込みの審査に関するタイムラインの概要が表示された申し込みのトラッカーがあります。
タイプ capital_
の Account Link を生成します。
リンクに移動し、申し込みのトラッカーを表示します。
申し込みを承認するダッシュボード
ダッシュボードで、受け付けたオファーに対応する行を探します。
- オーバーフローメニュー () をクリックします。
- 承認して資金を支払うオプションをクリックします。これにより申し込みの承認と資金の入金をシミュレーションできます。
- 資金が支払われたことを通知する
capital.
Webhook が届くことを確認します。financing_ offer. paid_ out - タイプ
capital_
の Account Link を新たに生成します。これで、レポートページではユーザーの進行中の融資に関する入金と返済取引の詳細にアクセスできるようになります。financing_ reporting - 支払いを行うをクリックして、支払い取引を作成します。
注
テスト環境の融資オファーのレポートページで支払いを行うボタンが有効になるまで、最長 15 分ほどかかります。
取引の処理後、取引の表で支払いを確認します。Financing Summary API を使用すると、進行中の融資でユーザーが返済した融資額をプログラムによって確認することができます。
融資のサマリーの取得が正常に行われると、次のようなレスポンスが返されます。
{ "object": "capital.financing_summary", "details": { "currency": "usd", "advance_amount": 1000000, "fee_amount": 100000, "withhold_rate": 0.2, "remaining_amount": 999950, "paid_amount": 50, "current_repayment_interval": { "due_at": 123456789, "remaining_amount": 50, "paid_amount": 50 }, "repayments_begin_at": 123456789, "advance_paid_out_at": 123456789 } }
融資を完済するダッシュボード
ダッシュボードで、資金を供給した融資に対応する行を探します。
- オーバーフローメニュー () をクリックします。
- オファーを返済するオプションをクリックします。これにより、融資残高の完済をシミュレーションできます。
- 融資が完済されたことを通知する
capital.
Webhook が届くことを確認します。financing_ offer. fully_ repaid - タイプ
capital_
の Account Link を新たに生成します。financing_ reporting
ユーザーが融資を完済した後は、いつでもレポートページで過去の融資の詳細を表示できます。
テスト環境の実装を確認する
ここまでで、お客様の実装は以下のようになっています。
capital.
Webhook を受けて、オファーメールを送信し、オファーを提供済みとしてマークするfinancing_ offer. created - プラットフォームのダッシュボードに融資申し込みのリンクを公開する
- プラットフォームのダッシュボードに融資レポートのリンクを公開する
プラットフォームのダッシュボードの Capital セクションは、ユーザーの融資の現在のフェーズに応じて表示が異なる場合があります。以下の状態図で、融資オファーに設定される可能性があるステータス値のリストをご確認ください。
自動オファーの有効化に向けて準備する
本番環境で自動オファーを有効にすると、Stripe は毎日、ユーザー向けの融資オファーを自動的に作成します。自動オファーを有効にする前に、以下について確認してください。
- コミュニケーションセンターを利用して、ユーザーのメールアドレスの確認と更新を行います。ユーザーが Capital の融資を利用するには、支払いの進捗状況の更新などの取引メールの受信できるようにするため、Stripe にメールアドレスが保存されている必要があります。
- Financing offers API の本番環境での利用の申請をご希望の場合は、こちらにお問い合わせください。
追加機能の有効化
時間の経過とともに、追加融資の利用が可能になるユーザーも存在します。追加融資は、進行中のローンの返済がかなり進んでいるユーザーに送られる追加の融資オファーです。追加融資オファーに対応できるように構築済みのシステムを更新するには、追加融資の導入ガイドをご使用ください。
プラットフォームのダッシュボードへの Capital 取引の導入をご希望の場合は、レポート作成と照合ガイドをご確認ください。